文档首页/ 应用运维管理 AOM/ API参考/ API/ 告警/ 新增消息通知模板
更新时间：2024-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新增消息通知模板

功能介绍

该接口用于新增消息通知模板。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/events/notification/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

Enterprise-Project-Id

否

String

企业项目id。

  • 新增单个企业项目下通知消息模板，填写企业项目id。

  • 不填，新增默认企业项目下通知消息模板。
表3 请求Body参数

参数

是否必选

参数类型

描述

desc

是

String

消息通知模板描述。

locale

是

String

消息通知模板语言。

name

是

String

消息通知模板名称。

templates

是

String

消息通知模板内容。

消息通知模板内容为json字符串，具体内容是由下列参数拼接成json数组后转义而来。

名称 是否必选 参数类型 说明
content 是 string 消息模板内容。
subType 是 string 消息模板发送类型，支持：email，sms，webhook。
topic 否 string 邮件主题。
sendType 否 string 当消息模板发送类型为“webhook”时需要指定消息模板格式，支持：HTML、JSON。
verison 是 string 默认为v2。

source

否

String

消息通知模板类型：

  • 不填：表示指标或事件模板

  • LTS：表示日志模板

响应参数

无

请求示例

新增消息通知模板的名称为test2的消息通知模板

/v2/{project_id}/events/notification/templates

{
  "desc" : "",
  "locale" : "zh-cn",
  "name" : "test2",
  "templates" : "[{\"subType\":\"email\",\"version\":\"v2\",\"topic\":\"${region_name}[${event_severity}_${event_type}_${clear_type}]于${starts_at}时间发生告警\",\"content\":\"告警名称：${event_name};\\n告警ID：${id};\\n告警行动规则：${action_rule};\\n触发时间：${starts_at};\\n触发级别：${event_severity};\\n告警内容：${alarm_info};\\n资源标识：${resources_new};\\n修复建议：${alarm_fix_suggestion_zh};\\n修复建议1：${alarm_fix_suggestion_zh};\\nTMS标签:  $event.annotations.tms_tags;\"},{\"subType\":\"sms\",\"version\":\"v2\",\"content\":\"告警名称：${event_name};  \\n告警ID：${id};  \\n告警时间：${starts_at};  \\n告警行动规则：${action_rule};  \\n告警级别：${event_severity};  \\n告警内容：${alarm_info};  \\n资源标识：${resources_new};  \\n修复建议：${alarm_fix_suggestion_zh};\"},{\"subType\":\"webhook\",\"version\":\"v2\",\"content\":\"通知类型：${event_type};\\n事件级别：${event_severity};\\n事件名称：$event.metadata.event_name;\\n发生时间：${starts_at};\\n事件源：$event.metadata.resource_provider;\\n资源类型：$event.metadata.resource_type;\\n资源标识：${resources_new};\\n可能原因：${alarm_probableCause_zh};\\n附加信息：${message};\\n修复建议：${alarm_fix_suggestion_zh};\",\"sendType\":\"HTML\"}]"
}

响应示例

无

状态码

状态码

描述

204

OK 请求响应成功。

错误码

请参见错误码。

父主题： 告警

相关文档