1. API Description
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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 |
No |
String |
Common Params. This parameter is not required for this API. |
| Filters.N |
No |
Array of Filter |
name Filter by Notification Channel Group Name.Type: String Required: No alarmNoticeId Filter by Notification Channel Group ID.Type: String Required: No uid Filter by Receiving User ID.Type: String Required: No groupId Filter by Receiving User Group ID.Type: String Required: No
deliverFlag Filter by Delivery Status.Type: String Required: No Optional Values: "1": Not Enabled, "2": Enabled, "3": Delivery ExceptionThe 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. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| AlarmNotices |
Array of AlarmNotice |
Alarm notification template list Note: this field may return null, indicating that no valid values can be obtained. |
| 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. |
4. Example
Example1 Getting the Notification Group List
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmNotices
<Common request parameters>
{}
Output Example
{
"Response": {
"TotalCount": 0,
"AlarmNotices": [],
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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. |