Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the alarm policy list.
A maximum of 30 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 | name -Filter by [alarm policy name]. -Type: String -Optional: No. -Example: test-alarm alarmId -Filter by [alert policy ID]. -Type: String -Optional: No. -Example: alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751 topicId -Filter by [log topic ID of the monitored object]. -Type: String -Optional: No. -Example: 6766f83d-659e-xxxx-a8f7-9104a1012743 enable -Filter by [Enabled status]. -Type: String -Remark: The parameter value range for enable is 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False. Other values will return error information. -Optional: No. -Example: true 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. |
| Parameter Name | Type | Description |
|---|---|---|
| Alarms | Array of AlarmInfo | Alarm policy list |
| TotalCount | Integer | Number of eligible alarm policies |
| 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. |
This example shows you how to get the list of alarm policies.
POST / HTTP/1.1
Host: cls.intl.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. |
| ResourceNotFound.TopicNotExist | The log topic 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