通知模板
通知模板:标记自定义默认通知模板
接口功能介绍
调用此接口可标记自定义默认通知模板。
接口约束
- 通知模板存在。
- 同一服务和维度下,自定义默认通知模板只能设置一个。
URI
POST /v4/monitor/mark-notice-template-isdefault
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
noticeTemplateID | 是 | String | 通知模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 | |
isDefault | 是 | Boolean | 是否为自定义默认通知模板 | false |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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/mark-notice-template-isdefault
请求头header
无
请求体body
{
"noticeTemplateID": "312b56b4-3e43-11ed-8ef2-005056898fe0",
"isDefault": false
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.NoticeTemplate.TemplateIDNotFound | 通知模板ID不存在 |
Monitor.NoticeTemplate.DefaultNoticeTemplateAlreadyExist | 自定义默认通知模板已存在 |
其他 | 参见公共错误码说明 |