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

文档中心

立即注册

导航

ManualTriggerInspect

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

调用 ManualTriggerInspect 接口，手动触发实例的某个巡检规则。

注意事项

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

使用说明

实例开启风险巡检功能后，系统将按照巡检周期定时执行巡检规则。如果您觉得巡检周期时间太长，您可以选择手动执行巡检规则。
手动执行巡检规则时，您需要知道 15 分钟内某个巡检任务只允许手动触发一次。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	是	rocketmq-cnoe12ef**	需要执行巡检规则的目标实例 ID，
Type	String	是	cluster	巡检规则的类型。 cluster：目前支持`queueInsufficient`巡检规则，巡检实例 Queue 资源是否不足。 topic：目前支持`queueBalance`巡检规则，巡检实例 Queue 分布是否不均衡。 group：目前支持`subscribeConsistency`巡检规则，巡检实例 Group 组订阅是否不一致。说明 5.x 版本实例不支持`subscribeConsistency`巡检规则。
InspectName	String	是	queueInsufficient	巡检任务名称。

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-cnoe12ef**

需要执行巡检规则的目标实例 ID，

Type

String

是

cluster

巡检规则的类型。

cluster：目前支持queueInsufficient巡检规则，巡检实例 Queue 资源是否不足。
topic：目前支持queueBalance巡检规则，巡检实例 Queue 分布是否不均衡。
group：目前支持subscribeConsistency巡检规则，巡检实例 Group 组订阅是否不一致。

说明

5.x 版本实例不支持subscribeConsistency巡检规则。

InspectName

String

是

queueInsufficient

巡检任务名称。

响应参数

无

请求示例

POST /?Action=ManualTriggerInspect&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-cnoe12efdd9****",
    "Type":"cluster",
    "InspectName":"queueInsufficient"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2024080621481941C2CF4020DC7E***",
        "Action": "ManualTriggerInspect",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {}
}