告警黑名单
告警黑名单：查询
接口功能介绍
查询告警黑名单列表。
接口约束
无。
URI
GET /v4/monitor/query-alarm-blacklists
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| deviceUUID | 否 | String | 设备UUID | xxxaadasd | |
| name | 否 | String | 告警黑名单名称 | 告警黑名单lyc123 | |
| service | 否 | String | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | ecs | |
| dimension | 否 | String | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| contactGroupID | 否 | String | 联系人组ID | 234bee06-16f6-5b0a-adb8-c0903d480a58 | |
| contactGroupName | 否 | String | 联系人组名称 | test | |
| createTimeFrom | 否 | Integer | 创建告警黑名单起始时间，精确到毫秒 | 1690428579920 | |
| createTimeTill | 否 | Integer | 创建告警黑名单截止时间，精确到毫秒 | 1690855839000 | |
| pageNo | 否 | Integer | 页码，默认为1 | 1 | |
| pageSize | 否 | Integer | 每页大小，默认为20 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| AlarmBlacklists | Array of Objects | 告警黑名单列表 | AlarmBlacklist | |
| totalCount | Integer | 总记录数 | 20 | |
| currentCount | Integer | 当前页记录数 | 5 | |
| totalPage | Integer | 总页数 | 3 |
表 AlarmBlacklist
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| blacklistID | String | 告警黑名单ID | 46d7bc83-7ac4-5238-a934-2076d0b9f9f0 | |
| regionID | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | String | 告警黑名单名称 | 告警黑名单lyc123 | |
| service | String | 服务 | ecs | |
| dimension | String | 告警维度 | 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 | |
| status | Integer | 告警黑名单状态 | 0 | |
| updateTime | Integer | 最近更新时间, 时间戳，精确到毫秒 | 1667459789000 | |
| createTime | Integer | 创建时间，时间戳，精确到毫秒 | 1667459789000 |
请求示例
请求url
/v4/monitor/query-alarm-blacklists?name=测试黑名单®ionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"AlarmBlacklists": [{
"blacklistID": "73d1d8bf-d31c-5bac-ba07-86ae2b30860b",
"name": "测试黑名单725",
"desc": "随便写",
"regionID": "81f7728662dd11ec810800155d307d5b",
"service": "ecs",
"dimension": "ecs",
"devices": ["xxxaadasd", "asdasdasgfasd"],
"metrics": ["cpu_util", "mem_util"],
"startTime": 1687337384,
"endTime": 1687338884,
"contactGroupList": ["234bee06-16f6-5b0a-adb8-c0903d480a58"],
"status": 0,
"createTime": 1690276540425,
"updateTime": 1690276540425
}]
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
