tencent cloud

DescribeAlarms
Last updated:2025-10-30 21:53:51
DescribeAlarms
Last updated: 2025-10-30 21:53:51

1. API Description

Domain name for API request: quota.intl.tencentcloudapi.com.

This API is used to query the alarm rule 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 Params. The value used for this API: DescribeAlarms.
Version Yes String Common Params. The value used for this API: 2024-12-04.
Region No String Common Params. This parameter is not required for this API.
Limit Yes Integer Number of items per page. maximum 100.
Offset Yes Integer Offset.
ProductId No Integer Product ID.
QuotaId No Integer Quota ID.
Content No String Alarm, quota name.
MemberUins.N No Array of Integer Member uins.
Metrics No Integer AlAlarm metric.
Id No Integer Rule ID

3. Output Parameters

Parameter Name Type Description
Count Integer Total number.
Data Array of Alarm List of rules
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 List of rules

Input Example

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

{
    "Limit": 10,
    "Offset": 0,
    "ProductId": 1
}

Output Example

{
    "Response": {
        "Count": 5,
        "Data": [
            {
                "Id": 102,
                "OwnerUin": 100026600000,
                "MemberUin": 100026600000,
                "Name": "234",
                "ProductId": 13,
                "Status": 2,
                "QuotaId": 2828,
"ProductName": "Tencent Cloud Assistant"
"QuotaName": "quota name 001"
                "Metrics": 1,
                "Threshold": 2,
                "Frequency": 1
            }
        ],
        "RequestId": "e3836e25-700a-4759-bba2-7bcd57b9ab86"
    }
}

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
InternalError Internal error.
ResourceNotFound.MemberNotExist Member not in organization.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback