告警黑名单
告警黑名单:变更状态
接口功能介绍
批量更新告警黑名单状态。
接口约束
告警黑名单存在。
URI
POST /v4/monitor/change-alarm-blacklists-status
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
blacklistIDList | 是 | Array of Strings | 告警黑名单ID列表 | ['5a592d2f-4869-5667-a088-b9d54336c166'] | |
status | 是 | Integer | 本参数表示告警黑名单状态。取值范围:0:启用。1:停用。根据以上范围取值。 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
returnObj | Object | 返回对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
success | Boolean | 是否成功 | true |
请求示例
请求url
/v4/monitor/change-alarm-blacklists-status
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"status":1,
"blacklistIDList":[
"5a592d2f-4869-5667-a088-b9d54336c166"
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success":true
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.AlarmBlacklist.NotFound | 告警黑名单不存在 |
其他 | 参见公共错误码说明 |