通知模板
通知模板：查看详情
接口功能介绍
调用此接口可查看通知模板详情。
接口约束
通知模板存在。
URI
GET /v4/monitor/describe-notice-template
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| noticeTemplateID | 是 | String | 通知模板ID | 315c7f8c-3e43-11ed-8ef2-005056898fe0 |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/describe-notice-template?noticeTemplateID=315c7f8c-3e43-11ed-8ef2-005056898fe0
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"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
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.NoticeTemplate.TemplateIDNotFound | 通知模板ID不存在 |
| 其他 | 参见公共错误码说明 |
