告警通知模板：創建
更新時間 2024-09-25 16:20:54
最近更新時間: 2024-09-25 16:20:54
分享文章
通知模板
通知模板：創建
接口功能介紹
調用此接口可創建通知模板。
接口約束
- 同一服務和維度下，通知模板數量至多10個。
- 同一服務和維度下，自定義默認通知模板只能設置一個。
- 其他參見請求參數說明。
URI
POST /v4/monitor/create-notice-template
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 通知模板名稱 ，長度2-40個字符。 | xsZSu | |
| service | 是 | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| dimension | 是 | String | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| contents | 是 | Array of Objects | 通知模板 | content | |
| isDefault | 否 | Boolean | 是否為自定義默認通知模板，默認值為false | false |
表 content
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| content | 是 | String | 通知模板內容， 長度不能超過400個字符。 | this is content | |
| notifyType | 是 | String | 本參數表示通知方式。取值范圍：sms：短信。email：郵件。 根據以上范圍取值。 | sms |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| noticeTemplateID | String | 通知模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 |
請求示例
請求url
/v4/monitor/create-notice-template
請求頭header
無
請求體body
{
"name": "test4",
"service": "ecs",
"dimension": "ecs",
"contents": [
{
"notifyType": "email",
"content": "this is a test"
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"noticeTemplateID": "c76ee847-fe89-5ab5-91bc-0407f01a3e6f"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.NoticeTemplate.NameAlreadyExist | 通知模板名稱已存在 |
| Monitor.NoticeTemplate.DefaultNoticeTemplateAlreadyExist | 自定義默認通知模板已存在 |
| Monitor.NoticeTemplate.NumberExceed | 通知模板數量超出范圍 |
| 其他 | 參見公共錯誤碼說明 |
