禁用告警规则。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=DisableAlertingRules&Version=2021-03-03
请求参数
| 参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DisableAlertingRules | 公共参数，本接口值：DisableAlertingRules。 |
| Version | String | 是 | 2021-03-03 | 公共参数，本接口值：2021-03-03。 |
| Ids | Array of String | 是 | ["90b5a3da-3464-4718-92e4-039bf41d3cff"] | 告警规则 ID 列表。 |
请求示例
POST /?Action=DisableAlertingRules&Version=2021-03-03
Content-Type:application/json
{
"Ids": ["90b5a3da-3464-4718-92e4-039bf41d3cff"]
}
返回参数
| 参数名称 | 类型 | 示例值 | 描述 |
|---|
| SuccessfulItems | Array of String | ["90b5a3da-3464-4718-92e4-039bf41d3cff"] | 成功禁用的告警规则 ID 列表。 |
| UnsuccessfulItems | Array of UnsuccessfulItem | - | 未成功禁用的告警规则信息。 |
UnsuccessfulItem
| 参数名称 | 类型 | 示例值 | 描述 |
|---|
| Id | String | a3ecbf7b-74d2-431b-a143-50a64bd0999f | 未成功禁用的告警规则 ID。 |
| Error | Object UnsuccessfulItemError | - | 未成功禁用的原因。 |
UnsuccessfulItemError
| 参数名称 | 类型 | 示例值 | 描述 |
|---|
| Code | String | NotFound.Ids | 错误码。 |
| Message | String | The specified AlertingRule {{id}} is not found. | 错误信息。 |
| Data | Map[String]String | - | 错误元数据。 |
返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"ResponseMetadata": {
"RequestId": "202211302208xxxx",
"Action": "DisableAlertingRules",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"SuccessfulItems": ["90b5a3da-3464-4718-92e4-039bf41d3cff"],
"UnsuccessfulItems": [
{
"Id": "a3ecbf7b-74d2-431b-a143-50a64bd0999f",
"Error": {
"Code": "NotFound.Ids",
"Message": "The specified AlertingRule {{id}} is not found."
}
}
]
}
}
错误码
本接口错误码如下表所示，公共错误码请参见 公共错误码。
| HTTP 状态码 | 错误码 | 错误信息 | 描述 |
|---|
| 404 | NotFound.Id | The specified AlertingRule {{Id}} is not found. | 未找到指定的告警规则。 |