CreateAlarm

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

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to create an alarm policy.

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: CreateAlarm.
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.
Name Yes String Alarm policy name
AlarmTargets.N Yes Array of AlarmTarget Monitoring object list
MonitorTime Yes MonitorTime Monitoring task running time point
Condition Yes String Trigger condition
TriggerCount Yes Integer Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by TriggerCount. Value range: 1–10.
AlarmPeriod Yes Integer Repeated alarm interval in minutes. Value range: 0–1440.
AlarmNoticeIds.N Yes Array of String List of associated alarm notification templates
Status No Boolean Whether to enable the alarm policy. Default value: true
MessageTemplate No String Custom alarm content
CallBack No CallBackInfo Custom callback
Analysis.N No Array of AnalysisDimensional Multi-Dimensional analysis

3. Output Parameters

Parameter Name Type Description
AlarmId String Alarm policy ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating alarm policy

Input Example

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

{
    "AlarmNoticeIds": [
        "notice-b02af159-f67b-44c3-877c-a55343f874c3"
    ],
    "Name": "test",
    "TriggerCount": 1,
    "AlarmPeriod": 0,
    "MonitorTime": {
        "Type": "Period",
        "Time": 10
    },
    "AlarmTargets": [
        {
            "TopicId": "be3d88bb-a9cb-4d29-b697-0fcfbfd601ef",
            "Number": 1,
            "Query": "* | select count(*) as count",
            "EndTimeOffset": 0,
            "StartTimeOffset": 0,
            "LogsetId": "fe3d45bb-a9cb-4d29-b697-0fcfbfd601ef"
        }
    ],
    "Condition": "$1.count > 10"
}

Output Example

{
  "Response": {
    "AlarmId": "alarm-479dec34-4a59-11eb-b378-0242ac130002",
    "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
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.AlarmConflict The alarm policy already exists.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.ACLFailed ACL verification failed.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
OperationDenied.AlarmNotSupportForSearchLow IA storage does not support alarms.
ResourceNotFound.AlarmNoticeNotExist The alarm notification template does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.