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

使用说明

巡检规则的相关配置不支持修改。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：GetInspectConfig

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

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

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

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

目标实例的 ID。

PageNumber integer 必选示例值：1

页码，最小值为 1。

PageSize integer 必选示例值：10

每页支持展示的巡检规则的数量，取值范围为 1~100。

Filters object 可选示例值："Filters": { "ConfigType": "cluster" }

过滤项，支持使用cluster、topic和group进行过滤巡检规则。

返回参数

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

InstanceId string 示例值：rocketmq-cnng33c94**

实例 ID。

Total integer 示例值：100

巡检规则数量。

Configs object[] 示例值：/

巡检规则的配置信息。

Type string 示例值：cluster

巡检项类型，可选值为cluster、topic、group。

InspectName string 示例值：queueBalance

巡检项名称。

StartInspectTimeStamp string 示例值：1725968687

上次手动触发巡检的时间。

Configurable object 示例值：/

巡检配置项支持用户可配置的参数。

Enable boolean 示例值：true

是否开启巡检项。

true：开启

false：关闭

Interval integer 示例值：30

巡检项巡检间隔周期，单位 s。

Describe string 示例值：实例 queue 分布不均衡

巡检配置项描述。

TriggerLimit integer 示例值：15

手动触发巡检的间隔时间，单位秒。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
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.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
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.	当前服务暂时不可用。

消息队列 RocketMQ版