DescribeAlarms

Last updated: 2022-01-04 11:28:03

1. API Description

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.

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.

2. Input Parameters

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 parameter. The value used for this API: DescribeAlarms.
Version Yes String Common parameter. The value used for this API: 2020-10-16.
Region Yes String Common parameter. 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

    Required: no


  • alarmId

    Filter by alarm policy ID
    Type: string

    Required: no


  • topicId

    Filter by log topic ID

    Type: string

    Required: no


  • enable

    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.

    3. Output Parameters

    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.

    4. Example

    Example1 Getting the alarm policy list

    Input Example

    POST / HTTP/1.1
    Host: cls.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAlarms
    <Common request parameters>
    
    {}
    

    Output Example

    {
      "Response": {
        "TotalCount": 0,
        "Alarms": [],
        "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
    OperationDenied Operation denied.
    OperationDenied.AccountDestroy The account has been terminated.
    OperationDenied.AccountIsolate The account has overdue payments.
    OperationDenied.AccountNotExists The account does not exist.