创建通知模板。 ## 请求说明 * 请求方式：POST * 请求地址：https://cloudmonitor.cn\-beijing.volcengineapi.com?Action=CreateNotifyTemplate&Version=2018\-01\-01 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateNotifyTemplate |接口名称。当前 API 的名称为 `CreateNotifyTemplate`。 | |Version |String |是 |2018\-01\-01 |接口版本。当前 API 的版本为 `2018-01-01`。 | |Name |String |是 |template\-demo |通知模版名称。|\ | | | | ||\ | | | | |* 字符串形式，支持中文、英文大小写和特殊字符。|\ | | | | |* 不能以数字、中划线`-`，特殊字符开头。|\ | | | | |* 长度限制为 1～128 字符。 | |Description |String |否 |this is a template\-demo |通知模版描述信息。|\ | | | | ||\ | | | | |* 字符串形式，支持中文、英文大小写和特殊字符。|\ | | | | |* 长度限制为 0～255 字符。 | |Type |String |是 |metric |通知模版类型，取值：|\ | | | | ||\ | | | | |* **metric**：告警通知模版。|\ | | | | |* **event**：事件通知模版。 | |Channel |String |是 |email |通知渠道，取值：|\ | | | | ||\ | | | | |* **email**：邮箱|\ | | | | |* **sms**：短信|\ | | | | |* **phone**：电话|\ | | | | |* **lark**：飞书|\ | | | | |* **dingtalk**：钉钉|\ | | | | |* **wecom**：企业微信|\ | | | | |* **slack**：Slack|\ | | | | |* **api**：回调地址 | |Title |String |否 |【{{ .Level \| translate "Level" "zh" }}】【{{ translate "Type" "zh" .Type }}】平台账户{{ .AccountName }}({{ .AccountId }})的告警策略"{{ .RuleName }}"{{ if (contains "Recovered" .Type) }}恢复正常{{ else }}发生{{ .Level \| translate "Level" "zh" }}级别告警{{ end }} |通知模版的标题，仅`Channel`配置为`email`、`lark`、`dingtalk`、`wecom`和`slack`时，需要配置。|\ | | | | |:::tip|\ | | | | ||\ | | | | |* 通知模版支持使用 Markdown 语法和 Go Template 语法来撰写和渲染通知内容。详情请参见 [模版语法简介](https://www.volcengine.com/docs/6408/1738948)、[扩展函数与变量](https://www.volcengine.com/docs/6408/1738920)。|\ | | | | |* 该字段在不同通知渠道时的字符数限制不同，详情请参见 [创建通知模版](https://www.volcengine.com/docs/6408/1738919)。|\ | | | | ||\ | | | | |:::| |Content |String |是 |**告警信息**：|通知模版的内容。|\ | | | |告警类型：{{ .Type }}|:::tip|\ | | | |账号名称：{{ .AccountName }}||\ | | | |账号 ID：{{ .AccountId }}|* 通知模版支持使用 Markdown 语法和 Go Template 语法来撰写和渲染通知内容。详情请参见 [模版语法简介](https://www.volcengine.com/docs/6408/1738948)、[扩展函数与变量](https://www.volcengine.com/docs/6408/1738920)。|\ | | | |告警策略名称：{{ .RuleName }}|* 该字段在不同通知渠道时的字符数限制不同，详情请参见 [创建通知模版](https://www.volcengine.com/docs/6408/1738919)。|\ | | | |告警策略 ID：{{ .RuleId }}||\ | | | |告警策略详情：{{ .RuleURL }} |:::| ## 请求示例 ```json POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateNotifyTemplate&Version=2018-01-01 Content-Type: application/json { "Channel": "email", "Content": "**告警信息**：\n\n告警类型：{{ .Type }}\n账号名称：{{ .AccountName }}\n账号 ID：{{ .AccountId }}\n告警策略名称：{{ .RuleName }}\n告警策略 ID：{{ .RuleId }}\n告警策略详情：{{ .RuleURL }}", "Description": "this is a template-demo", "Name": "template-demo", "Title": "【{{ .Level | translate \"Level\" \"zh\" }}】【{{ translate \"Type\" \"zh\" .Type }}】平台账户{{ .AccountName }}({{ .AccountId }})的告警策略\"{{ .RuleName }}\"{{ if (contains \"Recovered\" .Type) }}恢复正常{{ else }}发生{{ .Level | translate \"Level\" \"zh\" }}级别告警{{ end }}", "Type": "metric" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Data |String |189828\*\*\*00 |通知模版 ID。 | ## 返回示例 ```json { "ResponseMetadata": { "Action": "CreateNotifyTemplate", "Region": "cn-beijing", "Service": "cloudmonitor", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": "189828***00" } } ``` ## 错误码本接口无特有的错误码。更多信息请参见 [错误码](https://www.volcengine.com/docs/6408/78947)。

云监控