Help & DocumentationAuto ScalingAPI DocumentationAlarm Trigger Policy APIsCreateScalingPolicy

CreateScalingPolicy

Last updated: 2020-03-27 20:47:48

PDF

Contents：

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

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 Array of String | Notification group ID, which is the set of user group IDs and can be queried through the DescribeUserGroup 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 Number of Instances by 1 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

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    InvalidParameterValue.ScalingPolicyNameDuplicate The alarm policy name already exists.
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    ResourceNotFound.AutoScalingGroupIdNotFound The auto scaling group does not exist.