告警模板：更新
更新時間 2023-07-19 11:40:57
最近更新時間: 2023-07-19 11:40:57
分享文章
接口功能介紹
調用此接口可更新告警模板。
接口約束
告警模板內容不能為空。
URI
POST /v4/monitor/update-alarm-template
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| content | Object | 是 | 告警模板內容 | content | |
| templateID | String | 是 | 312b56b4-3e43-11ed-8ef2-005056898fe0 | 告警模板ID |
表content
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| name | String | 是 | xsZSu | 告警模板名稱 | |
| ser | String | 是 | ecs | 本參數表示告警服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | |
| dim | String | 是 | ecs | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | |
| desc | String | 否 | test | 告警模板描述 | |
| rules | Array of Objects | 是 | 告警規則 | rule |
表rule
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| for | Integer | 否 | 120 | 持續時間，當規則執行結果持續多久符合條件時報警（防抖），默認120s | |
| metric | String | 否 | cpu_util | 監控指標，默認為cpu_util | |
| fun | String | 否 | min | 本參數表示采用算法。默認值min。取值范圍：last：原始值。avg：平均值。max：最大值。min：最小值。根據以上范圍取值。 | |
| operator | String | 否 | le | 本參數表示比較符。默認值le。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根據以上范圍取值。 | |
| value | String | 否 | 80 | 告警閾值，整數、小數、百分數格式字符串，默認為80 | |
| period | String | 否 | 5m | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | |
| level | Integer | 否 | 1 | 本參數表示報警級別。默認值1。取值范圍：1：災難告警。2：嚴重告警。3：一般告警。4：警告告警。根據以上范圍取值。 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateID | String | 告警模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 |
請求示例
POST /v4/monitor/update-alram-template
請求體body
{
"templateID":"312b56b4-3e43-11ed-8ef2-005056898fe0",
"content":{
"name":"xsZSu",
"ser":"ecs",
"dim":"ecs",
"desc":"test",
"rules":[
{
"metric":"cpu_util",
"fun":"avg",
"value":"100",
"operator":"eq",
"for":120,
"period":"5m",
"level":3
},
{
"metric":"cpu_util",
"fun":"avg",
"value":"60",
"operator":"eq",
"for":120,
"period":"5m",
"level":1
}
]
}
}
響應示例
{
"statusCode":800,
"returnObj":{
"templateID":"312b56b4-3e43-11ed-8ef2-005056898fe0"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlarmTemplate.TemplateIDNotFound | 告警模板ID不存在 |
| 其他 | 參見公共錯誤碼說明 |
