GetInspectConfig--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

GetInspectConfig

最近更新时间：2024.08.22 15:30:40首次发布时间：2024.08.22 15:14:04

调用 GetInspectConfig 接口，查询巡检规则的相关配置。

注意事项

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

使用说明

巡检规则的相关配置不允许用户修改。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	rocketmq-cnng33c94**	目标实例的 ID。
PageNumber	Integer	是	1	页码，最小值为 1。
PageSize	Integer	是	10	每页支持展示的巡检规则的数量，取值范围为 1~100。
Filters	Map<String, String>	否	"Filters": { "ConfigType": "cluster" }	过滤项，支持使用`cluster`、`topic`和`group`进行过滤巡检规则。

响应参数

参数	参数类型	示例值	说明
Instance	String	rocketmq-cnng33c94**	实例 ID。
Total	String	1	巡检规则数量。
Configs	Array of InspectConfig	-	巡检规则的配置信息。
TriggerLimit	String	900	手动触发巡检的间隔时间，单位秒，即 15 分钟。

请求示例

POST /?Action=GetInspectConfig&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-cnng33c94**",
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": {
        "ConfigType": "cluster"
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20240819112436777BB8C4AEF90B27**",
        "Action": "GetInspectConfig",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "Configs": [
            {
                "Configurable": {
                    "Enable": true,
                    "Interval": 86400
                },
                "Describe": "实例queue资源不足",
                "InspectName": "queueInsufficient",
                "StartInspectTimeStamp": "1724036183409",
                "Type": "cluster"
            }
        ],
        "InstanceId": "rocketmq-cnng33c94**",
        "Total": 1,
        "TriggerLimit": 900
    }
}