Domain name for API request: cls.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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
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 |
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–10. |
AlarmPeriod | No | Integer | Repeated alarm interval in minutes. Value range: 0–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 |
MessageTemplate | No | String | Custom alarm content |
CallBack | No | CallBackInfo | Custom callback |
Analysis.N | No | Array of AnalysisDimensional | Multi-Dimensional analysis |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.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. |
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?