tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAlarmPolicyCondition

Last updated: 2023-08-11 16:09:22

1. API Description

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

This API is used to modify the trigger condition of 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 Params. The value used for this API: ModifyAlarmPolicyCondition.
Version Yes String Common Params. The value used for this API: 2018-07-24.
Region No String Common Params. This parameter is not required.
Module Yes String Module name, which is fixed at "monitor"
PolicyId Yes String Alarm policy ID
ConditionTemplateId No Integer ID of trigger condition template. This parameter can be left empty.
Condition No AlarmPolicyCondition Metric trigger condition
EventCondition No AlarmPolicyEventCondition Event trigger condition
Filter No AlarmPolicyFilter Global filter.
GroupBy.N No Array of String Aggregation dimension list, which is used to specify which dimension keys data is grouped by.
LogAlarmReqInfo No LogAlarmReq Log alarm creation request parameters
NoticeIds.N No Array of String Template ID, which is dedicated to TencentCloud Managed Service for Prometheus.
Enable No Integer Status (0: Disabled; 1: Enabled)
PolicyName No String Name of the policy dedicated to TMP
EbSubject No String The alert configured for an event

3. Output Parameters

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

4. Example

Example1 Editing the trigger condition of an alarm policy

This example shows you how to edit the trigger condition of an alarm policy.

Input Example

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

{
    "Module": "monitor",
    "PolicyId": "policy-hi498gw3h2",
    "Condition": {
        "IsUnionRule": 1,
        "Rules": [
            {
                "MetricName": "cpu_usage",
                "Period": 60,
                "Operator": "ge",
                "Value": "85",
                "ContinuePeriod": 1,
                "NoticeFrequency": 3600,
                "IsPowerNotice": 0
            }
        ]
    },
    "EventCondition": {
        "Rules": [
            {
                "MetricName": "ping_unreach"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "29ghj2hh-45-h53h234h-23"
    }
}

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
FailedOperation Operation failed.
FailedOperation.DoHTTPTransferFailed Backend service timed out.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is incorrect.
ResourceNotFound The resource is not found.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy