Release Notes
Announcements
Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify an alarm policy. At least one valid configuration item needs to be modified.
A maximum of 20 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: ModifyAlarm. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| AlarmId | Yes | String | Alarm policy ID |
| Name | No | String | Alarm policy name |
| MonitorTime | No | MonitorTime | Monitoring task running time point |
| Condition | No | String | Trigger condition. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive. |
| AlarmLevel | No | Integer | Alarm level.0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical) Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive. |
| MultiConditions.N | No | Array of MultiCondition | Multiple trigger conditions. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive. |
| TriggerCount | No | 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 to 10 |
| AlarmPeriod | No | Integer | Repeated alarm interval in minutes. Value range: 0 to 1440 |
| AlarmNoticeIds.N | No | Array of String | List of associated alarm notification templates |
| AlarmTargets.N | No | Array of AlarmTarget | Monitoring object list |
| Status | No | Boolean | Whether to enable the alarm policy |
| Enable | No | Boolean | This parameter has been deprecated. Use the Status parameter to control whether to enable the alarm policy. |
| MessageTemplate | No | String | Custom alarm content |
| CallBack | No | CallBackInfo | Custom callback |
| Analysis.N | No | Array of AnalysisDimensional | Multi-Dimensional analysis |
| GroupTriggerStatus | No | Boolean | Group trigger status. true: enabled; false: disabled (default) |
| GroupTriggerCondition.N | No | Array of String | Grouping trigger conditions. |
| Tags.N | No | Array of Tag | Tag description list, by specifying this parameter, you can simultaneously bind a Tag to the corresponding alarm policy. Up to 10 Tag key-value pairs are supported, and they must be unique. |
| MonitorObjectType | No | Integer | Monitored Object Type. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.When the value is 1, the number of AlarmTargets Elements (XML) cannot exceed 10, and the Numbers in AlarmTargets must be continuous positive integers starting from 1, without duplication. |
| Classifications.N | No | Array of AlarmClassification | Alarm additional classification information list. The number of Classifications elements cannot exceed 20.The Key of Classifications element must not be empty and duplicated, and its length cannot exceed 50 characters, complying with the regular expression ^a-z$.The Value length of Classifications element cannot exceed 200 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| 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 modify an alarm policy.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAlarm
<Common request parameters>
{
"AlarmNoticeIds": [
"notice-479dec34-4a59-11eb-b378-0242ac130002"
],
"Name": "test",
"TriggerCount": 1,
"AlarmPeriod": 0,
"MonitorTime": {
"Type": "Period",
"Time": 10
},
"AlarmTargets": [
{
"TopicId": "6f574591-01b0-4475-bf0c-68255839a35d",
"Number": 1,
"Query": "* | select source",
"EndTimeOffset": 0,
"StartTimeOffset": 0,
"LogsetId": "ff574591-01b0-4475-bf0c-68255839a35d"
}
],
"Condition": "$1.source='10.0.0.1'",
"AlarmId": "alarm-bea71170-4a59-11eb-b378-0242ac130002"
}{
"Response": {
"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 | Operation failed. |
| FailedOperation.InvalidAlarm | The alarm policy is exceptional. Please check whether all the log topic IDs exist. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.AlarmConflict | The alarm policy already exists. |
| InvalidParameter.DbDuplication | The unique key of database conflicts. |
| OperationDenied | Operation denied. |
| 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.AlarmNotExist | The alarm policy does not exist. |
| ResourceNotFound.AlarmNoticeNotExist | The alarm notification template 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