告警通知模板:刪除
更新時間 2024-09-25 16:20:55
最近更新時間: 2024-09-25 16:20:55
分享文章
通知模板
通知模板:刪除
接口功能介紹
調用此接口可批量刪除通知模板。
接口約束
通知模板存在。
URI
POST /v4/monitor/delete-notice-templates
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| noticeTemplateIDList | 是 | Array of Strings | 通知模板ID列表 | ['312b56b4-3e43-11ed-8ef2-005056898fe0','318cc4a8-3e43-11ed-8ef2-005056898fe0'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 刪除成功標識 | true |
請求示例
請求url
/v4/monitor/delete-notice-templates
請求頭header
無
請求體body
{
"noticeTemplateIDList":[
"315c7f8c-3e43-11ed-8ef2-005056898fe0",
"318cc4a8-3e43-11ed-8ef2-005056898fe0"
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.NoticeTemplate.SomeNoticeTemplatesNotFound | 部分通知模板不存在 |
| 其他 | 參見公共錯誤碼說明 |