告警規則：創建v4.1
更新時間 2024-12-05 10:41:04
最近更新時間: 2024-12-05 10:41:04
分享文章
告警規則
告警規則：創建
接口功能介紹
創建一個或多個告警規則。
接口約束
regionID（資源池）存在，service（服務）、dimension（維度）、rules（告警規則）滿足取值范圍，具體范圍見請求參數說明。
URI
POST /v4.1/monitor/create-alarm-rule
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 規則名 | 告警規則示例 | |
| service | 是 | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| dimension | 是 | String | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| conditions | 是 | Array of Objects | 具體告警匹配策略 | condition | |
| desc | 否 | String | 規則描述 | 規則描述 | |
| repeatTimes | 否 | Integer | 重復告警通知次數，默認為0 | 0 | |
| silenceTime | 否 | Integer | 告警接收策略靜默時間，多久重復通知一次，單位：秒 | 300 | |
| recoverNotify | 否 | Integer | 本參數表示恢復是否通知。默認值0。取值范圍：0：否。1：是。根據以上范圍取值。 | 0 | |
| notifyType | 否 | Array of Strings | 本參數表示告警接收策略。取值范圍：email：郵件告警。sms：短信告警。根據以上范圍取值。 | ['email','sms'] | |
| contactGroupList | 否 | Array of Strings | 告警聯系組 | ['fe7f0cdc-4692-5516-8d3a-b06355482090'] | |
| notifyWeekdays | 否 | Array of Integers | 本參數表示通知周期。默認值[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 | |
| webhookUrl | 否 | Array of Strings | webhook消息推送url | ['www.daliqc.cn'] | |
| resGroupID | 否 | String | 資源分組ID，與resources字段互斥。 1.以資源分組為資源對象的告警規則，不需要傳入resources。2.非資源分組為資源對象的告警規則，resources為必填項。 | eec4a76a-35ba-57b8-91c6-c4fd923351d6 | |
| resources | 是 | Array of Objects | 具體告警匹配資源 | resources | |
| projectID | 否 | String | 項目ID | 0 | |
| conditionType | 否 | Integer | 本參數表示告警策略觸發類型。默認值0。取值范圍：0：或，任一條件觸發。1：全部條件滿足觸發。根據以上范圍取值。 | 0 | 0 |
表 conditions
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| evaluationCount | 是 | Integer | 持續次數，當規則執行結果持續多久符合條件時報警（防抖），默認2次 | 2 | |
| metric | 是 | String | 監控指標 | cpu_util | |
| fun | 是 | String | 本參數表示告警采用算法。取值范圍：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。sum：求和算法。根據以上范圍取值。 | avg | |
| operator | 是 | String | 本參數表示比較符。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。rg：環比上升。cf：環比下降。rc：環比變化。根據以上范圍取值。 | eq | |
| value | 是 | String | 告警閾值，可以是整數、小數或百分數格式字符串 | 0 | |
| period | 是 | String | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | 5m | |
| unit | 是 | String | 單位，部分資源池不支持，默認為空 | bit |
表 resources
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| resource | 是 | Array of Objects | 資源信息 | resource |
表 resource
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | 是 | String | 資源實例標簽鍵 | uuid |
| value | 是 | 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 Strings | 告警規則ID列表 | ['83bd7537-9e06-5a45-a3b5-f4b13a7e81ea'] |
請求示例
請求url
/v4.1/monitor/create-alarm-rule
請求頭header
無
請求體body
{
"name": "告警規則名稱",
"desc": "描述",
"service": "ecs",
"dimension": "ecs",
"repeatTimes": 0,
"silenceTime": 300,
"notifyType": ["sms"],
"contactGroupList": ["096f8c1d-b905-57fd-aefe-f485f396722d"],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": ["www.daliqc.cn"],
"conditions": [{
"evaluationCount": 2,
"fun": "last",
"operator": "ge",
"unit": "%",
"value": "0",
"metric": "cpu_util"
}],
"resources": [{
"resource": [{
"name": "uuid",
"value": "7dd744ea-5a02-61d3-e627-38f82f5fd3e1"
}, {
"name": "instancename",
"value": "ecm-af97"
}]
}],
"conditionType": 1,
"regionID": "81f7728662dd11ec810800155d307d5b"
}
響應示例
{
"statusCode": 800,
"returnObj": {
"alarmRuleIDList": [
"83bd7537-9e06-5a45-a3b5-f4b13a7e81ea"
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
