You need to enable JavaScript to run this app.
导航
EnableInstanceInspect - 开启或关闭实例的风险巡检功能
最近更新时间:2024.11.18 10:27:32首次发布时间:2024.08.22 15:14:04

调用 EnableInstanceInspect 接口,开启或关闭实例的风险巡检功能。

使用说明

调用该接口,可以开启或关闭风险巡检功能。该接口异步生效,最多会有一分钟的延迟。

注意事项

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

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

EnableInstanceInspect

要执行的操作,取值:EnableInstanceInspect。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

rocketmq-cnoe12efd**

需要开启或关闭风险巡检功能的实例 ID。

Enable
Boolean

true

开启或关闭风险巡检功能。

  • true:开启
  • false:关闭

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST /?Action=EnableInstanceInspect&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-cnai1f0c29ca****",
  "Enable": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202408062205482873AD967BF2***",
        "Action": "EnableInstanceInspect",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

公共错误码请参见公共错误码文档。