CreateScalingPolicy

Documentation

Download PDF

Last updated: 2021-08-05 16:02:47

Download PDF

1. API Description

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

This API (CreateScalingPolicy) is used to create an alarm trigger policy.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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: CreateScalingPolicy.
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.
AutoScalingGroupId	Yes	String	Auto scaling group ID.
ScalingPolicyName	Yes	String	Alarm trigger policy name.
AdjustmentType	Yes	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	Yes	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.
MetricAlarm	Yes	MetricAlarm	Alarm monitoring metric.
Cooldown	No	Integer	Cooldown period in seconds. Default value: 300 seconds.
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.

3. Output Parameters

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

4. Example

Example1 Increasing the desired capacity by one if the average CPU utilization is over 50% within 1 minute for 5 consecutive occurrences

Input Example

https://as.tencentcloudapi.com/?Action=CreateScalingPolicy
&AutoScalingGroupId=asg-12wjuh0s
&ScalingPolicyName=cpu_policy_test
&AdjustmentType= CHANGE_IN_CAPACITY
&AdjustmentValue=1
&Cooldown=60
&MetricAlarm.ComparisonOperator=GREATER_THAN
&MetricAlarm.MetricName=CPU_UTILIZATION
&MetricAlarm.Statistic=AVERAGE
&MetricAlarm.Threshold=50
&MetricAlarm.Period=60
&MetricAlarm.ContinuousTime=5
&NotificationUserGroupIds.0=1678
&<Common request parameters>

Output Example

{
  "Response": {
    "AutoScalingPolicyId": "asp-iir70sxv",
    "RequestId": "fb02c8bd-5f38-4786-91b6-0c6e06a88832"
  }
}

Example2 Removing 50% instances if the average memory utilization is below 35% within 1 minute for 5 consecutive occurrences

Input Example

https://as.tencentcloudapi.com/?Action=CreateScalingPolicy
&AutoScalingGroupId=asg-12wjuh0s
&ScalingPolicyName=mem_policy_test
&AdjustmentType= PERCENT_CHANGE_IN_CAPACITY
&AdjustmentValue=-50
&Cooldown=300
&MetricAlarm.ComparisonOperator=LESS_THAN
&MetricAlarm.MetricName=MEM_UTILIZATION
&MetricAlarm.Statistic=AVERAGE
&MetricAlarm.Threshold=50
&MetricAlarm.Period=60
&MetricAlarm.ContinuousTime=5
&NotificationUserGroupIds.0=1678
&<Common request parameters>

Output Example

{
  "Response": {
    "AutoScalingPolicyId": "asp-f59pppuh",
    "RequestId": "116213d6-2269-44cc-af76-c4a8dc7dbdf9"
  }
}

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
InternalError.CallNotificationError	The notification service API call failed.
InvalidParameterValue.InvalidAutoScalingGroupId	Invalid scaling group ID.
InvalidParameterValue.InvalidNotificationUserGroupId	The notification group ID should be a numeric string.
InvalidParameterValue.LimitExceeded	The value exceeds the limit.
InvalidParameterValue.Range	The value is outside the specified range.
InvalidParameterValue.ScalingPolicyNameDuplicate	The alarm policy name already exists.
InvalidParameterValue.ThresholdOutOfRange	The specified threshold must be within the valid range.
InvalidParameterValue.TooLong	Too many values.
InvalidParameterValue.UserGroupIdNotFound	The user group does not exist.
LimitExceeded.QuotaNotEnough	You are short of the quota.
ResourceNotFound.AutoScalingGroupNotFound	The scaling group does not exist.

Recent Pages