告警黑名单
告警黑名单：更新
接口功能介绍
更新告警黑名单相关信息。
接口约束
告警黑名单存在。
URI
POST /v4/monitor/update-alarm-blacklist
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| blacklistID | 是 | String | 告警黑名单ID | 46d7bc83-7ac4-5238-a934-2076d0b9f9f0 | |
| name | 是 | String | 告警黑名单名称 | 告警黑名单123 | |
| service | 是 | String | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | ecs | |
| dimension | 是 | String | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| desc | 否 | String | 描述 | test | |
| devices | 是 | Array of Strings | 本参数表示设备列表。 | ['xxxaadasd', 'asdasdasgfasd'] | |
| contactGroupList | 是 | Array of Strings | 联系组列表 | ['234bee06-16f6-5b0a-adb8-c0903d480a58'] | |
| metrics | 否 | Array of Strings | 指标列表 | ['cpu_util', 'mem_util'] | |
| startTime | 否 | Integer | 开始时间 | 1687337384 | |
| endTime | 否 | Integer | 结束时间，结束时间必须要大于开始时间 | 1687338884 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/update-alarm-blacklist
请求头header
无
请求体body
{
"blacklistID": "46d7bc83-7ac4-5238-a934-2076d0b9f9f0",
"name": "测试黑名单725",
"desc": "testdesc",
"regionID": "81f7728662dd11ec810800155d307d5b",
"service": "ecs",
"dimension": "ecs",
"devices": ["xxxaadasd", "asdasdasgfasd"],
"metrics": ["cpu_util", "mem_util"],
"startTime": 1687337384,
"endTime": 1687338884,
"contactGroupList": ["234bee06-16f6-5b0a-adb8-c0903d480a58"]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success":true
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmBlacklist.NotFound | 告警黑名单不存在 |
| Monitor.AlarmBlacklist.ContactGroupNotFound | 告警黑名单联系人组不存在 |
| 其他 | 参见公共错误码说明 |
