Call the ModifyAlarmContentTemplate API to modify the alarm notification content template.

Notes

The call frequency limit for this API is 20 times per second. If the frequency limit is exceeded, the error ExceedQPSLimit will be returned.

Note

Request method: PUT

Request URL: https://{tls-endpoint}/ModifyAlarmContentTemplate

Request parameters

The table below lists only the request parameters unique to this interface and some common parameters. For more information, see public parameters.

Body

Parameter	Type	Required	Example value	Description
AlarmContentTemplateId	String	Is	5972a31a****	Alert notification content template ID.
AlarmContentTemplateName	String	Is	test-alarm-content-template	The name of the alarm notification content template. Please refer to Resource naming rules for naming rules.
DingTalk	Object of DingTalkContentTemplateInfo	No	/	DingTalk notification content template.
Email	Object of EmailContentTemplateInfo	No	/	The email notification content template.
Lark	Object of LarkContentTemplateInfo	No	/	A Feishu notification content template.
NeedValidContent	Boolean	No	true	Is it necessary to validate content templates?
Sms	Object of SmsContentTemplateInfo	No	/	SMS notification content template.
Vms	Object of VmsContentTemplateInfo	No	/	Voice notification content templates
WeChat	Object of WeChatContentTemplateInfo	No	/	WeCom notification content template.
Webhook	Object of WebhookContentTemplateInfo	No	/	Webhook alert notification template.

DingTalkContentTemplateInfo

Parameter	Type	Required	Example value	Description
Title	String	No	Alert notification	The subject of the alert notification.
Locale	String	No	zh-CN	The language of fixed content in alert notifications. Available values are zh-CN and en-US.
Content	String	No	Dear users, Hello！\nYour account (Master Account ID：{{AccountID}} ）of log service{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}\nAlarm Policy：{{Alarm}}\nAlarm topic：{{AlarmTopicName}}\nAlarm level：{{Severity}}\nFirst Trigger time：{{StartTime}}\nTriggering conditions：{{Condition}}\nCurrent query results：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\nAdditional Notification content：{{NotifyMsg\|escapejs}}\n\nThanks for supporting Torch Log Service	Alarm notification content supports plain text format and allows insertion of content variables, content functions, and more. For a detailed explanation, refer to content variable and content function. tip The maximum length of notification content after variable rendering is 8 KB. If the length exceeds this limit, the content will be truncated. Leaving the main content blank indicates that the default content will be used.

EmailContentTemplateInfo

Parameter	Type	Required	Example value	Description
Locale	String	No	zh-CN	The language of fixed content in alert notifications. The available values are zh-CN and en-US.
Content	String	No	Alarm policy: {{Alarm}}<br>Alarm project: {{ProjectName}}<br>	Alarm notification content supports plain text format and supports the insertion of content variables, content functions, and more. For detailed explanations, please refer to content variables and content functions. tip The maximum length of notification content after variable rendering is 8 KB. If the length exceeds this limit, the content will be truncated. Leave the main text empty to use the default content.
Subject	String	No	Alert notification	The email notification subject.

LarkContentTemplateInfo

Parameter	Type	Required	Example value	Description
Title	String	No	Alert notification	The subject of the alert notification.
Locale	String	No	zh-CN	The language of fixed content in alarm notifications. Available values are zh-CN and en-US.
Content	String	No	Dear users, Hello！\nYour account (Master Account ID：{{AccountID}} ）of log service{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}\nAlarm Policy：{{Alarm}}\nAlarm topic：{{AlarmTopicName}}\nAlarm level：{{Severity}}\nFirst Trigger time：{{StartTime}}\nTriggering conditions：{{Condition}}\nCurrent query results：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\nAdditional Notification content：{{NotifyMsg\|escapejs}}\n\nThanks for supporting Torch Log Service	Alarm notification content supports plain text format and supports the insertion of content variables, content functions, and more. For detailed instructions, please refer to content variables and content functions. tip The maximum length of notification content after variable rendering is 8 KB. Any content that exceeds this limit will be truncated. Leaving the main text blank indicates that the default content will be used.

SmsContentTemplateInfo

Parameter	Type	Required	Example value	Description
Locale	String	No	zh-CN	The language of fixed content in alert notifications can be set to either zh-CN or en-US.
Content	String	No	Alarm Policy{{Alarm}}， Alarm project：{{ProjectName}}， Alarm topic：{{AlarmTopicName}}， Alarm level：{{Severity}}， notification type：{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}，First Trigger time：{{StartTime}}， Triggering conditions：{{Condition}}， Current query results：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]，Additional Notification content：{{NotifyMsg}}	Alarm notification content supports plain text format and allows insertion of content variables, content functions, and more. For detailed explanations, refer to content variables and content functions. tip It is recommended to limit the length of the notification content after variable rendering to 256 characters or fewer; content that exceeds this limit may be truncated. Leaving the main content blank indicates that the default content will be used.

VmsContentTemplateInfo

Parameter	Type	Required	Example value	Description
Locale	String	No	zh-CN	The language of fixed content in alarm notifications. Available values are zh-CN and en-US.
Content	String	No	Notification type: {%if NotifyType==1%}Alert triggered{%else%}Alert recovered{%endif%}	Alarm notification content supports plain text format and the insertion of content variables, content functions, and more. For detailed information, refer to content variables and content functions. tip It is recommended to keep the length of the notification content after variable rendering within 256 characters, as content exceeding this limit may be truncated. Leaving the main text blank indicates that the default content will be used.

WeChatContentTemplateInfo

Parameter	Type	Required	Example value	Description
Title	String	No	Alert notification	The subject of the alarm notification.
Locale	String	No	zh-CN	The language of fixed content in alarm notifications. The selectable values are zh-CN and en-US.
Content	String	No	Dear users, Hello！\nYour account (Master Account ID：{{AccountID}} ）of log service{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}\nAlarm Policy：{{Alarm}}\nAlarm topic：{{AlarmTopicName}}\nAlarm level：{{Severity}}\nFirst Trigger time：{{StartTime}}\nTriggering conditions：{{Condition}}\nCurrent query results：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\nAdditional Notification content：{{NotifyMsg\|escapejs}}\n\nThanks for supporting Torch Log Service	Alarm notification content supports plain text format and supports inserting content variables, content functions, and more. For detailed information, refer to content variables and content functions. tip The maximum length of notification content after variable rendering is 8 KB. Content that exceeds this limit will be truncated. If the main text is left blank, the default content will be used.

WebhookContentTemplateInfo

Parameter	Type	Required	Example value	Description
Content	String	No	{ "msg_type": "interactive", "card": { "config": { "wide_screen_mode": true }, "elements": [ { "content": "Dear users, Hello！\nYour account (Master Account ID：{{AccountID}} ）of log service{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}\nAlarm Policy：{{Alarm}}\nAlarm topic：{{AlarmTopicName}}\nFirst Trigger time：{{StartTime}}\nTriggering conditions：{{Condition}}\nCurrent query results：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\nAdditional Notification content：{{NotifyMsg\|escapejs}}\n\nThanks for supporting Torch Log Service", "tag": "markdown" } ], "header": { "template": "{%if NotifyType==1%}red{%else%}green{%endif%}", "title": { "content": "【Torch Log Service】【Log Service】{%if NotifyType==1%}trigger alarm{%else%}revover alarm{%endif%}", "tag": "plain_text" } } } }	The content of alert notifications is usually in JSON format and supports the insertion of content variables, content functions, and more. For more details, please refer to content variables and content functions. tip The maximum length of notification content after variable rendering is 16 KB. Any content that exceeds this limit will be truncated. Leaving the main text blank indicates that the default content will be used.

Return parameters

This API does not have any specific return parameters. For more information, see Return structure.

Request example

Return example

Error codes

You can visit public error codes for more information.

Torch Log Service