告警模板：更新
更新時間 2024-09-25 16:20:55
最近更新時間: 2024-09-25 16:20:55
分享文章
告警模板
告警模板：更新
接口功能介紹
調用此接口可更新告警模板。
接口約束
告警模板內容不能為空。
URI
POST /v4/monitor/update-alarm-template
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| templateID | 是 | String | 告警模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 | |
| regionID | 是 | String | ctyun資源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 告警模板名稱 | xsZSu | |
| desc | 否 | String | 告警模板描述 | test | |
| service | 是 | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| dimension | 是 | String | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| conditions | 否 | Array of Objects | 告警規則 | condition |
表 condition
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| evaluationCount | 否 | Integer | 持續次數，當規則執行結果持續多久符合條件時報警（防抖），默認值：2 | 2 | |
| metric | 否 | String | 監控指標, 說明：當有condition參數時，metric是必填項 | cpu_util | |
| fun | 否 | String | 本參數表示采用算法。默認值：min。取值范圍：last：原始值。avg：平均值。max：最大值。min：最小值。sum：總和。根據以上范圍取值。 | min | |
| operator | 否 | String | 本參數表示比較符。默認值：le。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。ne：不等于。rg：環比上升。cf：環比下降。rc：環比變化。根據以上范圍取值。 | le | |
| value | 否 | String | 告警閾值，整數型或小數點型字符串， 默認值：80。 如果是小數點型字符串，小數點位數不能超過2位。 | 80 | |
| period | 否 | String | 本參數表示算法統計周期。默認值：5m。參數fun為last時不可傳。參數fun為avg、max、min、sum均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | 5m | |
| unit | 否 | String | 本參數表示單位. 默認值：空字符。 | KB/s |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateID | String | 告警模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 |
請求示例
請求url
/v4/monitor/update-alram-template
請求頭header
無
請求體body
{
"templateID":"312b56b4-3e43-11ed-8ef2-005056898fe0",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name":"xsZSu",
"service":"ecs",
"dimension":"ecs",
"desc":"test",
"conditions":[
{
"metric":"cpu_util",
"fun":"avg",
"value":"100",
"operator":"eq",
"evaluationCount":2,
"period":"5m"
},
{
"metric":"cpu_util",
"fun":"avg",
"value":"60",
"operator":"eq",
"evaluationCount":2,
"period":"5m"
}
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlarmTemplate.TemplateIDNotFound | 告警模板ID不存在 |
| Monitor.AlarmTemplate.NameAlreadyExist | 告警模板名稱已存在 |
| Monitor.AlarmTemplate.MetricInvalid | 告警模板監控項錯誤 |
| 其他 | 參見公共錯誤碼說明 |
