文档中心

消息队列 RocketMQ版

风险巡检

ManualTriggerInspect - 手动触发巡检

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

使用说明

实例开启风险巡检功能后，系统将按照巡检周期定时执行巡检规则。如果您觉得巡检周期时间太长，您可以选择手动执行巡检规则。

手动执行巡检规则时，您需要知道 15 分钟内某个巡检任务只允许手动触发一次。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ManualTriggerInspect

要执行的操作，取值：ManualTriggerInspect。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnoe12****

需要执行巡检规则的目标实例 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​
Host:  rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260114T101229Z​
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****",​
  "Type": "cluster",​
  "InspectName": "queueInsufficient"​
}​

返回示例

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.02.13 18:31:53

这个页面对您有帮助吗？

有用

无用