调用 CreateAlarmContentTemplate 接口创建告警通知内容模版。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AlarmContentTemplateName | String | 是 | test-alarm-content-template | 告警通知内容模版名称。命名规则请参考资源命名规则。 |
DingTalk | Object of DingTalkContentTemplateInfo | 否 | / | 钉钉通知内容模版。 |
Object of EmailContentTemplateInfo | 否 | / | 邮件通知内容模版。 | |
Lark | Object of LarkContentTemplateInfo | 否 | / | 飞书通知内容模版。 |
NeedValidContent | Boolean | 否 | true | 是否需要校验内容模版。 |
Sms | Object of SmsContentTemplateInfo | 否 | / | 短信通知内容模版。 |
Vms | Object of VmsContentTemplateInfo | 否 | / | 语音通知内容模版。 |
Object of WeChatContentTemplateInfo | 否 | / | 企业微信通知内容模版。 | |
Webhook | Object of WebhookContentTemplateInfo | 否 | / | 自定义的 Webhook 告警通知内容模版。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Title | String | 否 | 告警通知 | 告警通知内容的主题。 |
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。 |
Subject | String | 否 | 告警通知 | 邮件通知的主题。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Title | String | 否 | 告警通知 | 告警通知内容的主题。 |
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Title | String | 否 | 告警通知 | 告警通知内容的主题。 |
Locale | String | 否 | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String | 否 |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。 正文留空,表示使用默认内容。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Content | String | 否 |
| 告警通知内容,通常为 JSON 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 16 KB,超过限制长度后会被截断。 正文留空,表示使用默认内容。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AlarmContentTemplateId | String | 5972a31a**** | 告警通知模版 ID。 |
POST https://tls-{Region}.ivolces.com/CreateAlarmContentTemplate HTTP/1.1 Content-Type: application/json { "AlarmContentTemplateName": "test", "DingTalk": { "Content": "尊敬的用户,您好!\\n您的账号(主账户ID:{{AccountID}} )的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\\n告警策略:{{Alarm}}\\n告警日志主题:{{AlarmTopicName}}\\n触发时间:{{StartTime}}\\n触发条件:{{Condition}}\\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]\\n通知内容:{{NotifyMsg|escapejs}}\\n日志检索详情:[查看详情]({{QueryUrl|safe}})\\n告警详情:[查看详情]({{SignInUrl|safe}})\\n\\n感谢对火山引擎的支持", "Title": "TLS告警", "Locale": "zh-CN" }, "Email": { "Content": "告警策略:{{Alarm}}<br> \n告警日志项目:{{ProjectName}}<br> \n告警日志主题:{{AlarmTopicName}}<br> \n告警级别:{{Severity}}<br> \n触发时间:{{StartTime}}<br> \n触发条件:{{Condition}}<br> \n通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}<br> \n告警持续时间:{{Duration}}<br> \n通知内容:{{NotifyMsg}}", "Subject": "TLS告警", "Locale": "zh-CN" }, "Lark": { "Content": "尊敬的用户,您好!\\n您的账号(主账户ID:{{AccountID}} )的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\\n告警策略:{{Alarm}}\\n告警日志主题:{{AlarmTopicName}}\\n触发时间:{{StartTime}}\\n触发条件:{{Condition}}\\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]\\n通知内容:{{NotifyMsg|escapejs}}\\n日志检索详情:[查看详情]({{QueryUrl|safe}})\\n告警详情:[查看详情]({{SignInUrl|safe}})\\n\\n感谢对火山引擎的支持", "Title": "TLS告警", "Locale": "zh-CN" }, "WeChat": { "Content": "尊敬的用户,您好!\\n您的账号(主账户ID:{{AccountID}} )的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\\n告警策略:{{Alarm}}\\n告警日志主题:{{AlarmTopicName}}\\n触发时间:{{StartTime}}\\n触发条件:{{Condition}}\\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]\\n通知内容:{{NotifyMsg|escapejs}}\\n日志检索详情:[查看详情]({{QueryUrl|safe}})\\n告警详情:[查看详情]({{SignInUrl|safe}})\\n\\n感谢对火山引擎的支持", "Title": "TLS告警", "Locale": "zh-CN" }, "Webhook": { "Content": "{\n \"msg_type\": \"interactive\",\n \"card\": {\n \"config\": {\n \"wide_screen_mode\": true\n },\n \"elements\": [\n {\n \"content\": \"尊敬的用户,您好!\\n您的账号(主账户ID:{{AccountID}} )的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\\n告警策略:{{Alarm}}\\n告警日志主题:{{AlarmTopicName}}\\n触发时间:{{StartTime}}\\n触发条件:{{Condition}}\\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\\n通知内容:{{NotifyMsg|escapejs}}\\n\\n感谢对火山引擎的支持\",\n \"tag\": \"markdown\"\n }\n ],\n \"header\": {\n \"template\": \"{%if NotifyType==1%}red{%else%}green{%endif%}\",\n \"title\": {\n \"content\": \"【火山引擎】【日志服务】{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\",\n \"tag\": \"plain_text\"\n }\n }\n }\n}" }, "Vms": { "Content": "通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}", "Locale": "zh-CN" }, "Sms": { "Content": "告警策略{{Alarm}}, 告警日志项目:{{ProjectName}}, 告警日志主题:{{AlarmTopicName}}, 告警级别:{{Severity}}, 通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%},触发时间:{{StartTime}}, 触发条件:{{Condition}}, 当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}], 通知内容:{{NotifyMsg}}", "Locale": "zh-CN" }, "NeedValidContent": true }
HTTP/1.1 200 OK Content-Type:application/json; charset=utf-8 {"AlarmContentTemplateId":"28e1c****"}
您可访问公共错误码,获取更多错误码信息。