告警黑名單：查詢
更新時間 2024-09-25 16:20:58
最近更新時間: 2024-09-25 16:20:58
分享文章
告警黑名單
告警黑名單：查詢
接口功能介紹
查詢告警黑名單列表。
接口約束
無。
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
