一鍵告警：產品啟用
更新時間 2024-09-25 16:20:59
最近更新時間: 2024-09-25 16:20:59
分享文章
一鍵告警
一鍵告警：產品啟用
接口功能介紹
此接口用于啟用一個產品的一鍵告警規則，通知策略只對已啟用的一鍵告警規則生效。
接口約束
無。
URI
POST /v4/monitor/alert-onekey/enable-service
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmType | 是 | String | 本參數表示告警類型。 取值范圍：series：時序指標。event：事件。 根據以上范圍取值。 | series | |
| service | 是 | String | 本參數表示產品名稱。取值范圍：ecs：云主機。evs：云硬盤。...詳見“[一鍵告警：產品列表]”接口返回。 | ecs | |
| alarmConfigList | 是 | Array of Objects | 各個產品的初始化規則 | alarmConfig | |
| repeatTimes | 否 | Integer | 重復告警通知次數，默認值：0 | 0 | |
| silenceTime | 否 | Integer | 告警接收策略靜默時間，多久重復通知一次，單位為秒。 默認值：300 | 300 | |
| recoverNotify | 否 | Integer | 本參數表示恢復是否通知。默認值：0。取值范圍：0：否。1：是。根據以上范圍取值。 | 0 | |
| notifyType | 否 | Array of Strings | 本參數表示告警接收策略。取值范圍：email：郵件告警。sms：短信告警。根據以上范圍取值。 | ['email'] | |
| contactGroupList | 否 | Array of Strings | 告警聯系人組 | ['000f0322-1f4d-8cc8-bb2e-1c30fb751ccc'] | |
| 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推送地址 | ['//www.daliqc.cn'] |
表 alarmConfig
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| dimension | 是 | String | 本參數表示維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| name | 是 | String | 規則名 | test_name | |
| evaluationCount | 否 | Integer | 連續出現次數，默認值：0 | 0 | |
| metric | 是 | String | 指標名 | cpu_util | |
| status | 否 | Integer | 本參數表示告警規則啟用狀態，默認值：0。取值范圍：0：啟用。1：停用。根據以上范圍取值。 | 0 | |
| operator | 是 | String | 注意：一鍵告警規則的告警類型（alarmType）為事件類型（event）時，不需要傳入此參數；為其它告警類型時，是必填參數。 本參數表示比較符。默認值le。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根據以上范圍取值。 | eq | |
| value | 是 | String | 注意：一鍵告警規則的告警類型（alarmType）為事件類型（event）時，不需要傳入此參數；為其它告警類型時，是必填參數。 此參數表示告警閾值，可以是整數、小數或百分數格式字符串 | 20 | |
| unit | 否 | String | 單位 | % |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
請求url
/v4/monitor/alert-onekey/enable-service
請求頭header
無
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"alarmType":"series",
"alarmConfigList":[
{
"dimension":"ecs",
"name":"CPU使用率一鍵告警",
"metric":"cpu_util",
"evaluationCount":5,
"operator":"ge",
"value":"5%",
"status":0
},
{
"dimension":"ecs",
"name":"內存使用率一鍵告警",
"metric":"mem_util",
"evaluationCount":5,
"operator":"ge",
"value":"5%",
"status":0
}
],
"repeatTimes":0,
"silenceTime":300,
"recoverNotify":0,
"notifyType":[
"email"
],
"contactGroupList":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751ccc"
],
"notifyWeekdays":[
0,
1,
2,
3,
4,
5,
6
],
"notifyStart":"00:00:00",
"notifyEnd":"23:59:59",
"webhookUrl":["//www.daliqc.cn"]
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlertOnekey.ServiceAlreadyEnabled | 服務已啟用 |
| 其他 | 參見公共錯誤碼說明 |
