Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the notification group list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeAlarmNotices. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of Filter | name Filter by [notification channel group name]. Type: String "Filters":[{"Key":"name","Values":["test-notice"]}] Required: No alarmNoticeId Filter by [notification channel group ID]. Type: String "Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}] Required: No uid Filter by [recipient user ID]. Type: String "Filters": [{Key: "uid", Values: ["1137546"]}] Required: No groupId Filter by [recipient user group ID]. Type: String "Filters": [{Key: "groupId", Values: ["344098"]}] Required: No deliverFlag Filter by [delivery status]. Type: String Required: No Available values: "1": disabled, "2": enabled, "3": delivery exception "Filters":[{"Key":"deliverFlag","Values":["2"]}] The maximum number of Filters per request is 10, and the maximum for Filter.Values is 5. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| HasAlarmShieldCount | No | Boolean | Whether to return the quantity information of alarm silence statistics status in the configured notification channel group. - true: Need to return. - false: do not return (default false). |
| Parameter Name | Type | Description |
|---|---|---|
| AlarmNotices | Array of AlarmNotice | Alarm notification template list |
| TotalCount | Integer | Total number of eligible alarm notification templates |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmNotices
<Common request parameters>
{}
{
"Response": {
"TotalCount": 0,
"AlarmNotices": [
{
"Type": "",
"Name": "test-qywx",
"AlarmNoticeId": "notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f",
"CreateTime": "2025-08-06 15:47:00",
"UpdateTime": "2025-08-06 15:47:00",
"NoticeReceivers": [],
"WebCallbacks": [],
"Tags": [],
"JumpDomain": "https://console.tencentcloud.com",
"NoticeRules": [
{
"Rule": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}",
"NoticeReceivers": [],
"WebCallbacks": [
{
"Url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"CallbackType": "WeCom",
"Method": "",
"Headers": [],
"Body": "",
"Index": 1,
"NoticeContentId": "Default-zh",
"WebCallbackId": "",
"RemindType": 0,
"Mobiles": [],
"UserIds": []
}
],
"Escalate": false,
"Interval": 10,
"Type": 1
}
],
"DeliverStatus": 1,
"DeliverFlag": 1,
"AlarmNoticeDeliverConfig": null,
"AlarmShieldStatus": 2,
"AlarmShieldCount": {
"TotalCount": 0,
"InvalidCount": 0,
"ValidCount": 0,
"ExpireCount": 0
},
"CallbackPrioritize": true
}
],
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.TagQpsLimit | The frequency of tag service requests is limited. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback