ModifyScalingPolicy

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-18 11:13:38

Download PDF

1. API Description

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

This API (ModifyScalingPolicy) is used to modify an alarm trigger 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: ModifyScalingPolicy.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-19.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
AutoScalingPolicyId	Yes	String	Alarm policy ID.
ScalingPolicyName	No	String	Alarm policy name.
AdjustmentType	No	String	The method to adjust the desired number of instances after the alarm is triggered. Value range: CHANGE_IN_CAPACITY: Increase or decrease the desired number of instances EXACT_CAPACITY: Adjust to the specified desired number of instances PERCENT_CHANGE_IN_CAPACITY: Adjust the desired number of instances by percentage
AdjustmentValue	No	Integer	The adjusted value of desired number of instances after the alarm is triggered. Value range: When AdjustmentType is CHANGE_IN_CAPACITY, if AdjustmentValue is a positive value, some new instances will be added after the alarm is triggered, and if it is a negative value, some existing instances will be removed after the alarm is triggered When AdjustmentType is EXACT_CAPACITY, the value of AdjustmentValue is the desired number of instances after the alarm is triggered, which should be equal to or greater than 0 When AdjustmentType is PERCENT_CHANGE_IN_CAPACITY, if AdjusmentValue (in %) is a positive value, new instances will be added by percentage after the alarm is triggered; if it is a negative value, existing instances will be removed by percentage after the alarm is triggered.
Cooldown	No	Integer	Cooldown period in seconds.
MetricAlarm	No	MetricAlarm	Alarm monitoring metric.
NotificationUserGroupIds.N	No	Array of String	Notification group ID, which is the set of user group IDs. You can query the user group IDs through the ListGroups API. If you want to clear the user group, you need to pass in the specific string "NULL" to the list.

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 an alarm-triggered policy

Input Example

https://as.tencentcloudapi.com/?Action=ModifyScalingPolicy
&AutoScalingPolicyId=asp-iir70sxv
&ScalingPolicyName=cpu_policy_test
&AdjustmentType=CHANGE_IN_CAPACITY
&AdjustmentValue=1
&Cooldown=60
&MetricAlarm.ComparisonOperator=GREATER_THAN
&MetricAlarm.MetricName=CPU_USAGE
&MetricAlarm.Statistic=AVERAGE
&MetricAlarm.Threshold=50
&MetricAlarm.Period=60
&MetricAlarm.ContinuousTime=5
&NotificationUserGroupIds.0=1678
<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "91413a64-9587-486b-aef4-9aba5e8a0068"
  }
}

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
InvalidParameterValue.InvalidAutoScalingPolicyId	Invalid alarm-triggered policy ID.
InvalidParameterValue.InvalidNotificationUserGroupId	The notification group ID should be a numeric string.
InvalidParameterValue.Range	The value is outside the specified range.
InvalidParameterValue.ScalingPolicyNameDuplicate	The alarm policy name already exists.
ResourceNotFound.AutoScalingGroupNotFound	The scaling group does not exist.
ResourceNotFound.ScalingPolicyNotFound	The alarm policy does not exist.

Recent Pages