GetInstanceInspectResult - 查询实例巡检的异常结果--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

GetInstanceInspectResult - 查询实例巡检的异常结果

最近更新时间：2024.11.18 10:27:32首次发布时间：2024.08.22 15:14:05

调用 GetInstanceInspectResult 接口，查询实例巡检的异常结果。

使用说明

调用该接口，能够获取到实例所有的巡检异常结果。如果巡检正常，则不会返回。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetInstanceInspectResult	要执行的操作，取值：GetInstanceInspectResult。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnoe12ef**	需要查询巡检结果的目标实例 ID。
PageNumber	Integer	是	1	页码，最小值为 1。
PageSize	Integer	是	10	每页展示的巡检异常结果数量，取值范围为 1~100。
SortOrder	String	否	ASC	排序方式。 ASC：升序，默认排序方式。 DESC：降序。
SortBy	String	否	TimeStamp	排序项。目前仅支持按照巡检异常结果的发生时间进行排序。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceId	String	rocketmq-cnoe12efdd**	实例 ID。
Total	Integer	1	巡检异常结果总数。
Results	Array of Object	/	巡检异常结果列表。

请求示例

POST /?Action=GetInstanceInspectResult&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/RocketMQ/request, SignedHeaders=x-date, Signature=********

 {
    "InstanceId": "rocketmq-cnng33c941***",
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": {
        "Level": "low"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202408062203316AC862E450991***",
        "Action": "GetInstanceInspectResult",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-guilin-boe"
    },
    "Result": {
        "InstanceId": "rocketmq-cnoe1fd5d***",
        "Results": [
            {
                "Describe": "实例queue分布不均衡",
                "InspectName": "queueBalance",
                "Level": "medium",
                "Resource": [
                    "topic-test"
                ],
                "ResultId": "53ef64c4f1fe40b6b3ab**",
                "Status": "unSolved",
                "Suggestion": [
                    "1. 扩容queue, 会自动将queue rebalance到其他broker",
                    "2. 联系管理员对queue进行重均衡"
                ],
                "TimeStamp": "1722947090166",
                "Type": "topic"
            },
            {
                "Describe": "实例group组订阅不一致",
                "InspectName": "subscribeConsistency",
                "Level": "high",
                "Resource": [
                    "group-test"
                ],
                "ResultId": "47f2608227594b7383e50**",
                "Status": "unSolved",
                "Suggestion": [
                    "1. 检查消费者实例是否存在其他订阅"
                ],
                "TimeStamp": "1722948520710",
                "Type": "group"
            },
            {
                "Describe": "实例group组订阅不一致",
                "InspectName": "subscribeConsistency",
                "Level": "high",
                "Resource": [
                    "group-test"
                ],
                "ResultId": "80009988aa0047e0bf8127***",
                "Status": "unSolved",
                "Suggestion": [
                    "1. 检查消费者实例是否存在其他订阅"
                ],
                "TimeStamp": "1722951222513",
                "Type": "group"
            }
        ],
        "Total": 3
    }
}

错误码

公共错误码请参见公共错误码文档。