Domain name for API request: cls.tencentcloudapi.com.
This API is used to get the alarm policy 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: DescribeAlarms. |
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 | Filter by alarm policy name Type: string Required: no Filter by alarm policy ID Type: string Required: no Filter by log topic ID Type: string Required: no Filter by enablement status Type: string Note: The valid values of enable include 1 , t , T , TRUE , true , True , 0 , f , F , FALSE , false , and False . If other values are entered, an “invalid parameter” error will be returned.Required: no Each request can have up to 10 Filters and 5 Filter.Values . |
Offset | No | Integer | Page offset. Default value: 0 |
Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
Alarms | Array of AlarmInfo | Alarm policy list |
TotalCount | Integer | Number of eligible alarm policies |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarms
<Common request parameters>
{}
{
"Response": {
"TotalCount": 0,
"Alarms": [],
"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. |
OperationDenied | Operation denied. |
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?