告警模板：查詢列表
更新時間 2023-07-19 11:40:57
最近更新時間: 2023-07-19 11:40:57
分享文章
接口功能介紹
調用此接口可查詢告警模板列表。
接口約束
無。
URI
GET /v4/monitor/query-alarm-templates
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| showMode | String | 否 | ecs | 本參數表示展示出來的服務。默認返回所有服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | |
| templateType | String | 否 | all | 本參數表示模板類型。默認all。取值范圍：system：系統默認。custom：自定義。all：所有。根據以上范圍取值。 | |
| pageNo | Integer | 否 | 1 | 頁碼，默認為1 | |
| page | Integer | 否 | 1 | 頁碼，默認為1，建議使用pageNo，該參數后續會下線 | |
| pageSize | Integer | 否 | 2 | 頁大小，默認為20 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateList | Array of Objects | 告警模板列表 | template | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 14 | |
| page | Integer | 頁碼，建議參考請求參數pageNo，該參數后續會下線 | 1 | |
| pageSize | Integer | 頁大小，建議參考請求參數pageSize，該參數后續會下線 | 10 |
表template
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| templateID | String | 告警模板ID | 315c7f8c-3e43-11ed-8ef2-005056898fe0 | |
| lastUpdate | String | 最近更新時間 | 2022-09-27T09:03:03Z | |
| name | String | 告警模板名稱 | bzmcV | |
| service | String | 服務 | ecs | |
| dimension | String | 維度 | ecs | |
| desc | String | 告警模板描述 | test | |
| rules | Array of Objects | 告警規則 | rule |
表rule
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| for | Integer | 持續時間，當規則執行結果持續多久符合條件時報警（防抖） | 120 | |
| metric | String | 監控指標 | cpu_util | |
| fun | String | 算法 | min | |
| operator | String | 比較符 | le | |
| value | String | 告警閾值 | 80 | |
| period | String | 算法統計周期 | 5m | |
| level | Integer | 報警級別 | 1 |
請求示例
GET /v4/monitor/query-alarm-templates?showMode=evs&page=1&pageSize=5
響應示例
{
"statusCode":800,
"returnObj":{
"templateList":[
{
"templateID":"e10c380e-5406-11ed-8268-005056897257",
"lastUpdate":"2022-10-25T01:46:44Z",
"name":"template2",
"service":"evs",
"dimension":"disk",
"desc":"test",
"rules":[
{
"for":120,
"metric":"disk_util",
"fun":"avg",
"operator":"eq",
"value":"100",
"period":"5m",
"level":3
}
]
},
{
"templateID":"03c07784-5407-11ed-8268-005056897257",
"lastUpdate":"2022-10-25T01:47:42Z",
"name":"template3",
"service":"evs",
"dimension":"disk",
"desc":"test",
"rules":[
{
"for":120,
"metric":"disk_util",
"fun":"avg",
"operator":"eq",
"value":"100",
"period":"5m",
"level":3
}
]
}
],
"totalCount":2,
"totalPage":1,
"currentCount":2,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
