ModifyAlarmPolicyTasks

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-10-13 10:54:49

Download PDF

1. API Description

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

This API is used to modify the task triggered by an alarm policy. The TriggerTasks field contains the list of triggered tasks. If an empty array is passed in for TriggerTasks, it indicates to unbind all the triggered tasks from this 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: ModifyAlarmPolicyTasks.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-24.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
Module	Yes	String	Module name. Enter "monitor" here
PolicyId	Yes	String	Alarm policy ID
TriggerTasks.N	No	Array of AlarmPolicyTriggerTask	List of tasks triggered by alarm policy. If this parameter is left empty, it indicates to unbind all tasks

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 Modifying task triggered by alarm policy

Input Example

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

{
    "Module": "monitor",
    "PolicyId": "policy-29ng82fs",
    "TriggerTasks": [
        {
            "Type": "AS",
            "TaskConfig": "{\"Region\":\"ap-guangzhou\",\"Group\":\"asg-0zhspjx\",\"Policy\":\"asp-ganig28\"}"
        }
    ]
}

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

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
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	The parameter value is incorrect.
ResourceNotFound	The resource is not found.

Recent Pages