Call the DescribeAlarmNotifyGroups API to obtain the list of alarm notification groups.

Instructions for use

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

After the alarm feature is optimized, parameters prefixed with GeneralWebhook are used to bind custom Webhook addresses, while parameters prefixed 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 (for example, self-built systems, third-party alert systems, and many others). We recommend using webhook integration configuration. For detailed instructions, please refer to Creating a Webhook integration configuration.

If parameters beginning with AlarmWebhook are configured, the return values of parameters beginning with GeneralWebhook will be empty; if the AlarmContentTemplateId parameter is configured, the return value of the GeneralWebhookBody parameter will be empty; if the NoticeRules parameter is configured, the return values of the NotifyType and Receivers parameters will be empty.

Note

Request method: GET

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

Request parameters

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

Query

Parameter	Type	Required	Example value	Description
AlarmNotifyGroupName	String	No	group1	Alert notification group name.
AlarmNotifyGroupId	String	No	a*****	Alert notification group ID.
ReceiverName	String	No	zhangsan	IAM user name for receiving alerts.
IamProjectName	String	No	default	Filter by the IAM project name associated with the alert group. Exact match.
PageNumber	Integer	No	1	The page number for paginated queries. The default value is 1, which means that data is returned starting from the first page.
PageSize	Integer	No	20	Page size. The default is 20, and the maximum is 100.

Return parameters

The following table lists only the return parameters specific to this interface. For more information, see Return structure.

Parameter	Type	Example value	Description
AlarmNotifyGroups	Array of NotifyGroupsInfo	[ { "AlarmNotifyGroupName": "test1", "AlarmNotifyGroupId": "6ef**********", "NotifyType": [ "Recovery", "Trigger" ], "Receivers": [ { "ReceiverType": "User", "ReceiverNames": [ "****" ], "ReceiverChannels": [ "Sms" ], "StartTime": "00:00:00", "EndTime": "23:59:59" } ], "IamProjectName": "default", "CreateTime": "2022-04-21 07:31:09", "ModifyTime": "2022-04-21 07:31:09" } ]	List of alarm notification groups.
Total	Integer	1	Total number of alert notification groups that meet the criteria.

NotifyGroupsInfo

Parameter	Type	Example value	Description
Receivers	Array of Receiver	/	The list of IAM users who receive alerts. You can configure 1 to 10 IAM users.
CreateTime	String	2024-07-23 11:41:29	The creation time of the alert notification group.
ModifyTime	String	2024-07-23 11:41:32	The time when the alert notification group was modified.
NotifyType	Array of String	Trigger	Types of alert notifications. Optional values: select one or more: Trigger - alert trigger Alert recovery
IamProjectName	String	default	The IAM project to which the alert group belongs.
AlarmNotifyGroupId	String	t****	Alert notification group ID.
AlarmNotifyGroupName	String	test-alarm-nofify	The alert notification group name
NoticeRules	Array of NoticeRule	/	Notification group rules.

Receiver

Parameter	Type	Example value	Description
EndTime	String	23:59:59	End time for receiving alert notifications. 24-hour format: HH:mm:ss, time range: 00:00:00–23:59:59. StartTime cannot be greater than EndTime.
StartTime	String	00:00:00	The start time for receiving alarm notifications. 24-hour format, in the format HH:mm:ss, with a time range of 00:00:00 to 23:59:59. StartTime cannot be greater than EndTime.
ReceiverType	String	User	Recipient type. Can be set to: User: IAM user. UserGroup: IAM user group.
ReceiverNames	Array of String	["Andy"]	IAM user or user group name.
ReceiverChannels	Array of String	["Sms"]	Notification channels. Email: email. SMS: Short message service Phone: Telephone. GeneralWebhook: Custom Webhook address. Lark: Feishu. DingTalk: DingTalk. WeChat: WeCom.
GeneralWebhookUrl	String	https://xxxx.feushu.com/xxxx	A custom interface callback address
GeneralWebhookBody	String	/	Custom WebHook request bodies 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	user1	Username to be notified when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration configuration tip Specifying reminder recipients is only supported when the ReceiverChannels parameter is set to DingTalk or WeChat. When you configure parameters that start with AlarmWebhook, this means you have chosen to use the Webhook integration configuration method to manage the Webhook address. In this case, please leave parameters that start with GeneralWebhook blank; there is no need to configure them. After specifying a reminder recipient, the notification content in WeCom is in plain text format and does not support Markdown format. After specifying a reminder recipient, the IAM user's mobile phone number must be a mainland China number.
AlarmWebhookIsAtAll	Boolean	true	When configuring Webhook integration to send notifications to Feishu, DingTalk, or WeCom, should all users be notified? true: Remind everyone. false: Does not notify everyone. tip When you configure parameters prefixed with AlarmWebhook, it means you have chosen to use the Webhook integration configuration method to manage the Webhook address. In this case, please leave parameters prefixed with GeneralWebhook empty; no configuration is required. When you choose to notify everyone, the notification content in WeCom will be in plain text format and does not support Markdown formatting.
AlarmWebhookAtGroups	Array of String	group1	When configuring Webhook integration to send notifications to Feishu, DingTalk, or WeCom, you need to specify the name of the user group to be notified. tip When you have configured parameters that start with AlarmWebhook, this means you are managing the Webhook address by using Webhook integration configuration. In this case, please leave parameters that start with GeneralWebhook blank; no configuration is required.
GeneralWebhookMethod	String	POST	Custom interface callback methods can only be set to POST or PUT.
GeneralWebhookHeaders	Array of GeneralWebhookHeaderKV	/	Custom interface callback request headers
AlarmContentTemplateId	String	al****	Alarm content template ID.
AlarmWebhookIntegrationId	String	1f4a9e21****	ID of the alert webhook integration configuration. tip When you configure parameters starting with AlarmWebhook, this means you are using the Webhook integration configuration method to manage the Webhook address. In this case, please leave parameters starting with GeneralWebhook blank; no configuration is required.
AlarmWebhookIntegrationName	String	test	The name of the alert Webhook integration configuration. tip When you configure 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.

NoticeRule

Parameter	Type	Example value	Description
HasNext	Boolean	true	Conditional check for whether to proceed to the next layer.
RuleNode	Object of RuleNode	/	Rule nodes.
HasEndNode	Boolean	true	Whether there is a subsequent end node.
ReceiverInfos	Array of Receiver	/	Notification channel information

GeneralWebhookHeaderKV

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

RuleNode

Parameter	Type	Example value	Description
Type	String	Operation	Current node type. Optional values: Operation: A node that performs an operation. Condition: Condition node
Value	Array of String	/	Node value.
Children	Array of RuleNode	[ "AND"]	Child node.

Request example

Return example

Error codes

The following table lists the error codes related to this interface and business logic. 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.
500	InternalServerError	We encountered an unexpected server error . Please try again later.	Internal server error.

Torch Log Service