CreateAlarm

Last updated:2025-10-30 21:53:52

CreateAlarm

Last updated: 2025-10-30 21:53:52

1. API Description

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

Add alarm rules

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: CreateAlarm.
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.
Name	Yes	String	Alarm rule name. specifies the name of the Alarm rule.
ProductId	Yes	Integer	Product ID.
QuotaId	Yes	Integer	Quota ID.
Metrics	Yes	Integer	Alert metrics 1: quota usage 2: quota usage rate 3: remaining quota 4: remaining quota rate.
Threshold	Yes	Integer	Specifies the Alarm threshold. value range: 0-100.
Frequency	Yes	Integer	Alarm frequency.
MemberUin	No	Integer	Member UIN.

3. Output Parameters

Parameter Name	Type	Description
AlarmId	Integer	1001
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 Creating a Quota Alarm

Input Example

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

{
    "Name": "Quota 2",
    "ProductId": 2,
    "QuotaId": 3,
    "Metrics": 1,
    "Threshold": 1,
    "Frequency": 1
}

Output Example

{
    "Response": {
        "AlarmId": 119,
        "RequestId": "573f1a99-3b45-40bd-8c63-fdd311e1998e"
    }
}

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

Tencent Cloud CLI 3.0

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
ResourceNotFound.AlarmNotExist	Alarm rule does not exist.
ResourceNotFound.MemberNotExist	Member not in organization.
ResourceNotFound.ProductNotExist	Product is not exist.
ResourceNotFound.UserQuotaNotExist	UserQuota is not exist.
UnsupportedOperation.AlarmIsExist	Alarm name is exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud