消息队列 RocketMQ版
消息队列 RocketMQ版
文档指南
请输入
- 文档首页
消息队列 RocketMQ版API 参考风险巡检GetInstanceInspectResult - 查询实例巡检的异常结果
复制全文
下载 pdfGetInstanceInspectResult - 查询实例巡检的异常结果
文档反馈
问问助手调用 GetInstanceInspectResult 接口，查询实例巡检的异常结果。
使用说明
调用该接口，能够获取到实例所有的巡检异常结果。如果巡检正常，则不会返回。
注意事项
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：GetInstanceInspectResult
要执行的操作，取值：GetInstanceInspectResult。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
InstanceId string 必选 示例值：rocketmq-cnoe12****
需要查询巡检结果的目标实例 ID。
PageNumber integer 必选 示例值：1
页码，最小值为 1。
PageSize integer 必选 示例值：10
每页展示的巡检异常结果数量，取值范围为 1~100。
SortOrder string 可选 示例值：ASC
排序方式。
- ASC：升序，默认排序方式。
- DESC：降序。
SortBy string 可选 示例值：TimeStamp
排序项。目前仅支持按照巡检异常结果的发生时间进行排序。
返回参数
UnExpectedCnt integer 示例值：2
异常数量。
InspectCnt integer 示例值：2
巡检数量。
InstanceId string 示例值：rocketmq-cnoe12ef****
实例 ID。
Total integer 示例值：1
巡检异常结果总数。
Results object[] 示例值：/
巡检异常结果列表。
InspectName string 示例值：queueBalance
巡检项的名称。
Type string 示例值：Topic
巡检项类型。
ResultId string 示例值：519fe2c3f72e4ea2a1e49****
巡检结果唯一 ID。
Level string 示例值：medium
巡检结果的风险等级。
- low：低风险
- medium：中风险
- high：高风险
Resource string[] 示例值：test1,test2
巡检结果关联资源。
TimeStamp string 示例值：1722944022630
巡检异常结果的发生时间戳。
Status string 示例值：unSolved
巡检异常结果的状态。
- unSolved：未处理
- Solved：已处理
Suggestion string[] 示例值：1. 扩容queue, 会自动将queue rebalance到其他broker,2. 联系管理员对queue进行重均衡
异常结果的处理建议。
Describe string 示例值：实例queue分布不均衡
巡检项的描述。
请求示例
POST /?Action=GetInstanceInspectResult&Version=2023-01-01 HTTP/1.1
Host: rocketmq.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260114T102133Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260114/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceId": "rocketmq-cnoe12****",
"PageNumber": 1,
"PageSize": 10
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260115173728054144081088D6****",
"Action": "GetInstanceInspectResult",
"Version": "2023-01-01",
"Service": "RocketMQ",
"Region": "cn-beijing"
},
"Result": {
"UnExpectedCnt": 2,
"InspectCnt": 2,
"InstanceId": "rocketmq-cnoe12ef****",
"Total": 1,
"Results": [
{
"InspectName": "queueBalance",
"Type": "Topic",
"ResultId": "519fe2c3f72e4ea2a1e49****",
"Level": "medium",
"Resource": [
"test1","test2"
],
"TimeStamp": "1722944022630",
"Status": "unSolved",
"Suggestion": [
"1. 扩容queue, 会自动将queue rebalance到其他broker","2. 联系管理员对queue进行重均衡"
],
"Describe": "实例queue分布不均衡"
}
]
}
}
错误码
最近更新时间：2026.02.13 18:31:53
这个页面对您有帮助吗？
有用
有用
无用
无用