告警規則：創建
更新時間 2023-07-19 11:40:58
最近更新時間: 2023-07-19 11:40:58
分享文章
接口功能介紹
創建一個或多個告警規則。
接口約束
regionID（資源池）存在，service（服務）、dimension（維度）、level（報警級別）、rules（告警規則）滿足取值范圍，具體范圍見請求參數說明。
URI
POST /v4/monitor/create-alarm-rule
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun資源池ID | |
| name | String | 是 | 告警規則lyc123 | 規則名 | |
| service | String | 是 | ecs | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | |
| dimension | String | 是 | ecs | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | |
| level | Integer | 是 | 1 | 本參數表示報警級別。取值范圍：1：災難告警。2：嚴重告警。3：一般告警。4：警告告警。根據以上范圍取值。 | |
| rules | Array of Objects | 是 | 具體匹配規則 | rule | |
| desc | String | 否 | test | 描述 | |
| repeatTimes | Integer | 否 | 0 | 重復告警通知次數，默認為0 | |
| silenceTime | Integer | 否 | 300 | 告警接收策略靜默時間，多久重復通知一次，單位為秒 | |
| recoverNotify | Integer | 否 | 0 | 本參數表示恢復是否通知。默認值0。取值范圍：0：否。1：是。根據以上范圍取值。 | |
| notifyType | Array of String | 否 | ["email","sms"] | 本參數表示告警接收策略。取值范圍：email：郵件告警。sms：短信告警。根據以上范圍取值。 | |
| contactGroupList | Array of String | 否 | ["test"] | 告警聯系人組 | |
| notifyWeekdays | Array of Integer | 否 | [0,1,2,3,4,5,6] | 本參數表示通知周期。默認值[0,1,2,3,4,5,6]。取值范圍：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根據以上范圍取值。 | |
| notifyStart | String | 否 | 00:00:00 | 通知起始時段，默認為00:00:00 | |
| notifyEnd | String | 否 | 23:59:59 | 通知結束時段，默認為23:59:59 |
表rule
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| for | Integer | 否 | 120 | 持續時間，當規則執行結果持續多久符合條件時報警（防抖），默認120s | |
| metric | String | 是 | cpu_util | 監控指標 | |
| fun | String | 是 | avg | 本參數表示告警采用算法。取值范圍：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根據以上范圍取值。 | |
| operator | String | 是 | eq | 本參數表示比較符。默認值le。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根據以上范圍取值。 | |
| value | String | 是 | 0 | 告警閾值，可以是整數、小數或百分數格式字符串 | |
| period | String | 是 | 5m | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | |
| deviceUUID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 資源唯一值 | |
| deviceType | String | 是 | vm | 資源類型 | |
| instanceID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 資源ID | |
| instanceName | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 資源名稱 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alarmRuleIDList | Array of String | 告警規則ID（alarmRuleID）列表 | ["83bd7537-9e06-5a45-a3b5-f4b13a7e81ea","02591baf-175f-5905-94fb-99b93df48e0b"] |
請求示例
POST /v4/monitor/create-alarm-rule
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "告警規則lyc123",
"desc": "test",
"repeatTimes": 0,
"service": "ecs",
"dimension": "ecs",
"level": 1,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": ["email"],
"contactGroupList": [],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"rules": [
{
"for": 300,
"metric": "mem_util",
"fun": "avg",
"operator": "ge",
"value": "0",
"period": "5m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceType": "vm",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
},
{
"for": 300,
"metric": "cpu_util",
"fun": "avg",
"operator": "ge",
"value": "1000",
"period": "5m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceType": "vm",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"alarmRuleID": [
"83bd7537-9e06-5a45-a3b5-f4b13a7e81ea",
"02591baf-175f-5905-94fb-99b93df48e0b"
]
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
