调用 DescribeAlarmContentTemplates 接口查询告警通知内容模版。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AlarmContentTemplateName | String | 否 | group1 | 告警通知内容模版名称。 |
AlarmContentTemplateId | String | 否 | 5972a31a**** | 告警通知内容模版 ID。 |
OrderField | String | 否 | CreateTime/ModifyTime | 用于排序的字段。 |
ASC | Boolean | 否 | true | 是否升序排列。 |
PageNumber | Integer | 否 | 1 | 分页页码。 |
PageSize | Integer | 否 | 20 | 页面大小。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AlarmContentTemplates | Array of ContentTemplateInfo | / | 告警内容模板列表。 |
Total | Integer | 10 | 告警内容模板数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Sms | Object of SmsContentTemplateInfo | / | 短信通知内容模板相关信息。 |
Vms | Object of VmsContentTemplateInfo | / | 电话通知内容模板相关信息。 |
Lark | Object of LarkContentTemplateInfo | / | 飞书通知内容模板相关信息。 |
Object of EmailContentTemplateInfo | / | 邮件通知内容模板相关信息。 | |
Object of WeChatContentTemplateInfo | / | 企业微信通知内容模板相关信息。 | |
Webhook | Object of WebhookContentTemplateInfo | / | 自定义 Webhook 通知内容模板相关信息。 |
DingTalk | Object of DingTalkContentTemplateInfo | / | 钉钉通知内容模板相关信息。 |
IsDefault | Boolean | true | 是否为内置的内容模版。 |
CreateTime | String | 告警通知内容模版的创建时间。 | |
ModifyTime | String | 告警通知内容模板的修改时间。 | |
AlarmContentTemplateId | String | 5972a31a**** | 告警通知内容模板 ID。 |
AlarmContentTemplateName | String | group1 | 告警通知内容模板名称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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,超过限制长度后会被截断。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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,超过限制长度后会被截断。 正文留空,表示使用默认内容。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Content | String |
| 告警通知内容,通常为 JSON 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 16 KB,超过限制长度后会被截断。 正文留空,表示使用默认内容。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Title | String | 告警通知 | 告警通知内容的主题。 |
Locale | String | zh-CN | 告警通知中固定内容的语言,可选值为 zh-CN、en-US。 |
Content | String |
| 告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量、内容函数。 说明 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。 |
GET https://tls-{Region}.ivolces.com/DescribeAlarmContentTemplates?&AlarmContentTemplateName=group1&AlarmContentTemplateId=&OrderField=CreateTime/ModifyTime&ASC=true&PageNumber=1&PageSize=20 HTTP/1.1 Content-Type: application/json
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "Total": 4, "AlarmContentTemplates": [ { "AlarmContentTemplateName": "默认模版", "AlarmContentTemplateId": "default-template", "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}" }, "Email": { "Content": "告警策略:{{Alarm}}\u003cbr\u003e \n告警日志项目:{{ProjectName}}\u003cbr\u003e \n告警日志主题:{{AlarmTopicName}}\u003cbr\u003e \n告警级别:{{Severity}}\u003cbr\u003e \n触发时间:{{StartTime}}\u003cbr\u003e \n触发条件:{{Condition}}\u003cbr\u003e \n通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\u003cbr\u003e \n告警持续时间:{{Duration}}\u003cbr\u003e \n通知内容:{{NotifyMsg}}", "Subject": "TLS告警", "Locale": "zh-CN" }, "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" }, "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" }, "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" }, "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" }, "CreateTime": "2023-12-15 15:05:07", "ModifyTime": "2024-04-09 10:34:34", "IsDefault": true }, { "AlarmContentTemplateName": "test001", "AlarmContentTemplateId": "28e1c037-****", "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}" }, "Email": { "Content": "告警策略:{{Alarm}}\u003cbr\u003e \n告警日志项目:{{ProjectName}}\u003cbr\u003e \n告警日志主题:{{AlarmTopicName}}\u003cbr\u003e \n告警级别:{{Severity}}\u003cbr\u003e \n触发时间:{{StartTime}}\u003cbr\u003e \n触发条件:{{Condition}}\u003cbr\u003e \n通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\u003cbr\u003e \n告警持续时间:{{Duration}}\u003cbr\u003e \n通知内容:{{NotifyMsg}}", "Subject": "TLS告警", "Locale": "zh-CN" }, "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" }, "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" }, "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" }, "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" }, "CreateTime": "2024-07-23 10:31:38", "ModifyTime": "2024-07-23 10:32:31", "IsDefault": false }, { "AlarmContentTemplateName": "钉钉告警", "AlarmContentTemplateId": "4394379d-****", "Webhook": { "Content": "{\n \"msgtype\": \"markdown\",\n \"markdown\": {\n \"title\":\"TLS火山告警\",\n \"text\": \"{{notifyMsg|escapejs}}\"\n },\n \"at\": {\n \"isAtAll\": true\n }\n }" }, "Email": { "Content": "告警策略:{{Alarm}}\u003cbr\u003e \n告警日志项目:{{ProjectName}}\u003cbr\u003e \n告警日志主题:{{AlarmTopicName}}\u003cbr\u003e \n告警级别:{{Severity}}\u003cbr\u003e \n触发时间:{{StartTime}}\u003cbr\u003e \n触发条件:{{Condition}}\u003cbr\u003e \n通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\u003cbr\u003e \n告警持续时间:{{Duration}}\u003cbr\u003e \n通知内容:{{NotifyMsg}}", "Subject": "TLS告警", "Locale": "zh-CN" }, "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" }, "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" }, "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" }, "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" }, "CreateTime": "2024-07-19 11:21:58", "ModifyTime": "2024-07-19 11:21:58", "IsDefault": false }, { "AlarmContentTemplateName": "aaa", "AlarmContentTemplateId": "71fb6170****", "Webhook": { "Content": "{\n \"msg_type\": \"interactive\",\n \"card\": {\n \"config\": {\n \"wide_screen_mode\": true\n },\n \"elements\": [\n {\n \"alt\": {\n \"content\": \"\",\n \"tag\": \"plain_text\"\n },\n \"img_key\": \"img_v2_bfd72a81-1533-4699-995d-12a675708d0g\",\n \"tag\": \"img\"\n },\n {\n \"tag\": \"div\",\n \"text\": {\n \"content\": \"你是否曾因为一本书而产生心灵共振,开始感悟人生?\\n你有哪些想极力推荐给他人的珍藏好书?\\n\\n加入 **4·23 飞书读书节**,分享你的**挚爱书单**及**读书笔记**,**赢取千元读书礼**!\\n\\n📬 填写问卷,晒出你的珍藏好书\\n😍 想知道其他人都推荐了哪些好书?马上[入群围观](https://open.feishu.cn/)\\n📝 用[读书笔记模板](https://open.feishu.cn/)(桌面端打开),记录你的心得体会\\n🙌 更有惊喜特邀嘉宾 4月12日起带你共读\",\n \"tag\": \"lark_md\"\n }\n },\n {\n \"actions\": [\n {\n \"tag\": \"button\",\n \"text\": {\n \"content\": \"查看活动指南\",\n \"tag\": \"plain_text\"\n },\n \"type\": \"default\",\n \"url\": \"{{SignInUrl|safe}}\"\n }\n ],\n \"tag\": \"action\"\n }\n ],\n \"header\": {\n \"template\": \"turquoise\",\n \"title\": {\n \"content\": \"📚晒挚爱好书,赢读书礼金\",\n \"tag\": \"plain_text\"\n }\n }\n }\n}" }, "Email": { "Content": "", "Subject": "TLS 告警", "Locale": "zh-CN" }, "Vms": { "Content": "", "Locale": "zh-CN" }, "Sms": { "Content": "", "Locale": "zh-CN" }, "Lark": { "Content": "", "Title": "TLS 告警", "Locale": "zh-CN" }, "DingTalk": { "Content": "", "Title": "TLS 告警", "Locale": "zh-CN" }, "WeChat": { "Content": "", "Title": "TLS 告警", "Locale": "zh-CN" }, "CreateTime": "2024-03-01 18:06:10", "ModifyTime": "2024-03-01 18:22:15", "IsDefault": false } ] }
您可访问公共错误码,获取更多错误码信息。