1. API Description
Domain name for API request: pts.intl.tencentcloudapi.com.
This API is used to query alert recipient groups.
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: DescribeAlertChannels. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-07-28. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| ProjectIds.N |
Yes |
Array of String |
Array of Project ID. |
| Offset |
No |
Integer |
Offset. Default value is 0. |
| Limit |
No |
Integer |
Number of returns, default is 20, maximum is 100. |
| NoticeIds.N |
No |
Array of String |
Array of Notice ID. |
| OrderBy |
No |
String |
Column for sorting. |
| Ascend |
No |
Boolean |
Whether in ascending order. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| AlertChannelSet |
Array of AlertChannelRecord |
Alarm recipient groups list.
Note: This field may return null, indicating that no valid value is found. |
| Total |
Integer |
Number of alarm recipient groups.
Note: This field may return null, indicating that no valid value is found. |
| 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 Querying alarm recipient groups
POST / HTTP/1.1
Host: pts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlertChannels
<Common request parameters>
{
"OrderBy": "asc",
"Ascend": true,
"Limit": 1,
"Offset": 1,
"ProjectIds": [
"project-xx"
]
}
Output Example
{
"Response": {
"AlertChannelSet": [
{
"Status": 1,
"NoticeId": "notice-xx",
"ProjectId": "projecct-xx",
"UpdatedAt": "2022-09-09 13:11:12",
"AMPConsumerId": "consumer-xx",
"CreatedAt": "2022-09-09 13:11:12",
"AppId": 0,
"Uin": "abc",
"SubAccountUin": "abc"
}
],
"Total": 1,
"RequestId": "req-xx"
}
}
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.DbQueryFailed |
Failed to query database. |