Call the ModifyAlarmNotifyGroup API to modify the alert notification group.

Instructions for use

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

After the alarm feature is optimized, parameters beginning with GeneralWebhook are used to bind custom webhook addresses, while parameters beginning with AlarmWebhook are used to bind webhook integration configurations.

Both methods allow you to send alert notifications to Feishu groups, DingTalk groups, WeCom groups, or other custom webhook addresses (such as custom-built systems, third-party alert systems, and more). We recommend using webhook integration. For detailed instructions on Webhook integration configuration, refer to Create a Webhook integration configuration. For instructions on configuring the two methods, please refer to the ReceiverChannels parameter.

When modifying parameters, if you configure any parameters starting with AlarmWebhook, the system will clear all parameters starting with GeneralWebhook. If you configure the AlarmContentTemplateId parameter, the system will clear the GeneralWebhookBody parameter configuration. If you configure the NoticeRules parameter, the system will clear the configurations for the NotifyType and Receivers parameters.

Note

Request method: PUT

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

Request parameters

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

Body

Parameter	Type	Required	Example value	Description
AlarmNotifyGroupId	String	Is	p****	Alert notification group ID.
AlarmNotifyGroupName	String	No	test-alarm-nofify	Alert notification group name. Please refer to Resource naming rules for naming rules.
NotifyType	Array of String	No	["Recovery", "Trigger"]	Types of alert notifications. Can be set to: Trigger: Alert trigger Recovery: Alarm restored tip If the NoticeRules parameter is configured, the NotifyType and Receivers parameters must be left blank. If the NoticeRules parameter is empty, you must configure the NotifyType and Receivers parameters.
Receivers	Array of Receiver	No	[ { "ReceiverType": "User", "ReceiverNames": ["******"], "ReceiverChannels": ["Sms"], "StartTime": "00:00:00", "EndTime": "23:59:59" } ]	List of IAM users who receive alerts. You can create 1 to 10 IAM users. tip If the NoticeRules parameter is configured, the NotifyType and Receivers parameters must be left blank. If the NoticeRules parameter is empty, you must configure the NotifyType and Receivers parameters.
NoticeRules	Array of NoticeRule	No	/	Alert notification group configuration tip If the NoticeRules parameter is configured, the NotifyType and Receivers parameters must be left blank. If the NoticeRules parameter is empty, you must configure the NotifyType and Receivers parameters.

Receiver

Parameter	Type	Required	Example value	Description
EndTime	String	Is	23:59:59	End time for receiving alert notifications. 24-hour format, with the format HH:mm:ss and a time range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
StartTime	String	Is	00:00:00	The start time for receiving alarm notifications. Use the 24-hour time format: HH:mm:ss. The valid time range is 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
ReceiverType	String	Is	User	Receive object types. Can be set to: User: IAM user. UserGroup: IAM user group.
ReceiverNames	Array of String	Is	["Andy"]	IAM user or user group names.
ReceiverChannels	Array of String	Is	["Sms"]	Channels for receiving notifications. Supports configuring one or more channels. Can be set to: Email: Email message. The alert email domain used by TLS is mail.tls.volcengine.com. You can add this domain to the allowlist of the target mailbox to prevent alert emails from being blocked. SMS: text message. Phone If the call is not connected, it will not be redialed, and a free SMS notification will be sent one time. TLS uses the numbers 02132222528 and 02132222527 to send alert notifications. You can add these numbers to your phone's allowlist to prevent alert calls from being blocked. GeneralWebhook: Custom webhook address. Lark: Feishu DingTalk: DingTalk. WeChat: WeCom (the enterprise version of WeChat) tip ReceiverChannels includes Lark and DingTalk Or when using WeChat, you must configure the AlarmWebhookIntegrationId, AlarmWebhookIntegrationName, and AlarmContentTemplateId parameters, and leave all parameters starting with GeneralWebhook blank. When ReceiverChannels contains GeneralWebhook but does not contain Lark, DingTalk, or WeChat, the configuration instructions are as follows: (Recommended) Configure the AlarmWebhookIntegrationId, AlarmWebhookIntegrationName, and AlarmContentTemplateId parameters, and leave each parameter that begins with GeneralWebhook blank. Configure all parameters that begin with GeneralWebhook, and leave parameters that begin with AlarmWebhook and AlarmContent blank.
GeneralWebhookUrl	String	No	https://xxxx.feushu.com/xxxx	Custom interface callback address.
GeneralWebhookBody	String	No	/	Customize a WebHook request body. It is recommended to set the request body content according to the format requirements of the callback interface for the corresponding service.
AlarmWebhookAtUsers	Array of String	No	user1	When configuring Webhook integration to send notifications to Feishu, DingTalk, or WeCom, specify the username to be notified. tip Specifying reminder recipients is supported only when the ReceiverChannels parameter is set to DingTalk or WeChat. When you configure parameters that start with AlarmWebhook, this means you have chosen to manage the Webhook address using the Webhook integration configuration method. In this case, please leave parameters that start with GeneralWebhook blank; configuration is not required. After specifying a reminder recipient, notification content in Enterprise WeChat is in plain text format and does not support Markdown format. After designating a reminder recipient, the IAM user's mobile phone number must be a mainland China number.
AlarmWebhookIsAtAll	Boolean	No	true	When sending notifications to Feishu, DingTalk, or WeCom through Webhook integration configuration, should all users be notified? true: Remind everyone. false: Do not notify everyone. tip When you configure parameters that start with AlarmWebhook, this means you have chosen to manage the Webhook address using the Webhook integration configuration method. In this case, please leave parameters that start with GeneralWebhook blank; no configuration is required. When you choose to notify everyone, the notification content in Enterprise WeChat will be in plain text format and does not support Markdown.
AlarmWebhookAtGroups	Array of String	No	group1	The name of the user group to be notified when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration configuration. tip When you configure parameters that start with AlarmWebhook, you have chosen to manage the Webhook address using Webhook integration. In this case, please leave parameters that start with GeneralWebhook blank; no configuration is required.
GeneralWebhookMethod	String	No	POST	Custom interface callback methods can only be set to POST or PUT.
GeneralWebhookHeaders	Array of GeneralWebhookHeaderKV	No	/	A custom request header for interface callbacks
AlarmContentTemplateId	String	No	al****	Alarm content template ID.
AlarmWebhookIntegrationId	String	No	1f4a9e21****	The ID of the alert Webhook integration configuration. tip When you have configured parameters that start with AlarmWebhook, it indicates that you have chosen to manage the Webhook address using the Webhook integration configuration method. In this case, please leave parameters that start with GeneralWebhook blank; no configuration is required.
AlarmWebhookIntegrationName	String	No	test	Name of the alert Webhook integration configuration. tip When you configure parameters that start with AlarmWebhook, it means you have chosen to manage the Webhook address using the Webhook integration configuration method. In this case, please leave parameters that start with GeneralWebhook blank. No configuration is required.

NoticeRule

Parameter	Type	Required	Example value	Description
HasNext	Boolean	No	true	Conditional check for whether to proceed to the next layer.
RuleNode	Object of RuleNode	No	/	Rule nodes.
HasEndNode	Boolean	No	true	Is there an end node afterwards.
ReceiverInfos	Array of Receiver	No	/	Notification channel information.

GeneralWebhookHeaderKV

Parameter	Type	Required	Example value	Description
key	String	No	Content-Type	Key of the custom request header.
value	String	No	application/json	The Value of a custom request header.

RuleNode

Parameter	Type	Required	Example value	Description
Type	String	No	Operation	The current node type. Optional values: Operation nodes. Condition: Condition node
Value	Array of String	No	/	Node value.
Children	Array of RuleNode	No	[ "AND"]	Child node.

Return parameters

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

Request example

Return example

Error codes

The table below lists the error codes related to this interface and business logic. For public error codes, please refer to the public error codes document.

HTTP status codes	Error codes	Error message	Description
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	Invalid parameter.
400	AlarmNoticeUserNotExist	Alarm notice user %s not exist	Alert notification user does not exist.
404	AlarmNotifyGroupNotExist	AlarmNotify Group does not exist.	The alert notification group does not exist.
409	NotifyGroupAlreadyExist	Notify group already exist	The alert notification group already exists.
500	InternalServerError	We encountered an unexpected server error . Please try again later.	Internal server error.

Torch Log Service