告警通知模板：查詢列表
更新時間 2024-09-25 16:20:55
最近更新時間: 2024-09-25 16:20:55
分享文章
通知模板
通知模板：查詢列表
接口功能介紹
調用此接口可查詢通知模板列表。
接口約束
參見請求參數說明。
URI
GET /v4/monitor/query-notice-templates
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| service | 否 | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| dimension | 否 | String | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| name | 否 | String | 名稱模糊搜索 | template | |
| pageNo | 否 | Integer | 頁碼，默認為1 | 1 | |
| pageSize | 否 | Integer | 頁大小，默認為10 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| noticeTemplateList | Array of Objects | 通知模板 | noticeTemplate | |
| totalCount | Integer | 總記錄數 | 20 | |
| currentCount | Integer | 當前頁記錄數 | 10 | |
| totalPage | Integer | 總頁數 | 2 | |
| pageNo | Integer | 頁碼 | 1 | |
| pageSize | Integer | 頁大小 | 10 |
表 noticeTemplate
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| noticeTemplateID | String | 通知模板ID | 315c7f8c-3e43-11ed-8ef2-005056898fe0 | |
| name | String | 通知模板名稱 | bzmcV | |
| service | String | 服務 | ecs | |
| dimension | String | 維度 | ecs | |
| contents | Array of Objects | 通知模板 | content | |
| isDefault | Boolean | 是否為自定義默認通知模板 | false | |
| createTime | Integer | 創建時間，時間戳，精確到秒 | 1667459789 | |
| updateTime | Integer | 最近更新時間，時間戳，精確到秒 | 1667459789 |
表 content
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| content | String | 通知模板內容 | this is content | |
| notifyType | String | 本參數表示通知方式。取值范圍：sms：短信。email：郵件。 根據以上范圍取值。 | sms |
請求示例
請求url
/v4/monitor/query-notice-templates
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"noticeTemplateList": [
{
"name": "test4",
"service": "ecs",
"dimension": "ecs",
"isDefault": false,
"contents": [
{
"notifyType": "email",
"content": "this is a content test"
}
],
"noticeTemplateID": "9d3b38e1-7bba-50dd-9a7e-8435446028fd",
"createTime": 1718180979,
"updateTime": 1718180979
}
],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1,
"pageNo": 1,
"pageSize": 10
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
