告警黑名單：創建
更新時間 2024-09-25 16:20:58
最近更新時間: 2024-09-25 16:20:58
分享文章
告警黑名單
告警黑名單：創建
接口功能介紹
創建一個告警黑名單。
接口約束
regionID（資源池）存在，service（服務）、dimension（維度）滿足取值范圍，具體范圍見請求參數說明。
URI
POST /v4/monitor/create-alarm-blacklist
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun資源池ID | 81f7728662dd11ec810800155d307d5b | |
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alarmBlacklistID | String | 告警黑名單ID | "46d7bc83-7ac4-5238-a934-2076d0b9f9f0" |
請求示例
請求url
/v4/monitor/create-alarm-blacklist
請求頭header
無
請求體body
{
"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": {
"alarmBlacklistID": "5a592d2f-4869-5667-a088-b9d54336c166"
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlarmBlacklist.ContactGroupNotFound | 告警黑名單聯系人組不存在 |
| 其他 | 參見公共錯誤碼說明 |
