Tenant Cloud Compute Auto Scaling Alarm Trigger Policy APIs CreateScalingPolicy

CreateScalingPolicy

Last Updated At: 2026-08-02 00:05:29

1. Interface Description

Interface request domain name: as.api3.convergecloud.com.

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

Default interface request rate limit: 20 times per second.

Interface update time: 2022-11-04 09:58:02.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: CreateScalingPolicy
Version Yes No String Public parameter, The value of this interface: 2018-04-19
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
AutoScalingGroupId Yes No String ID of the scaling group.
Example: asg-12wjuh0s
ScalingPolicyName Yes No String Name of the alarm trigger policy.
Example: cpu_policy_
AdjustmentType Yes No String Method that you want to use to change the desired capacity after the alarm is triggered. Valid values:
  • CHANGE_IN_CAPACITY: Increase or decrease the desired capacity.
  • EXACT_CAPACITY: Adjust to the specified desired capacity.
    •  
  • PERCENT_CHANGE_IN_CAPACITY: Adjust the desired capacity by percentage.

    • Example: CHANGE_IN_CAPACITY
    AdjustmentValue Yes No Int64 Adjusted desired capacity after the alarm is triggered. Valid values:
  • When the AdjustmentType parameter is set to CHANGE_IN_CAPACITY, some new instances will be added after the alarm is triggered if the AdjustmentValue parameter is set to a positive value, and some existing instances will be removed after the alarm is triggered if the AdjustmentValue parameter is set to a negative value. 
    •  
  •  When the AdjustmentType parameter is set to EXACT_CAPACITY, the value of the AdjustmentValue parameter specifies the desired number of instances after the alarm is triggered, which must be equal to or greater than 0. 
    •  
  •  When the AdjustmentType parameter is set to PERCENT_CHANGE_IN_CAPACITY, new instances will be added by percentage after the alarm is triggered if the AdjusmentValue parameter is set to a positive value, and existing instances will be removed by percentage after the alarm is triggered if the AdjusmentValue parameter is set to a negative value. Unit: %.
    Example: 1
    		•
    Cooldown No No Uint64 Cooldown period. Unit: seconds. Default value: 300.
    Example: 60
    MetricAlarm Yes No MetricAlarm Alarm metric.
    Example:View
    NotificationUserGroupIds No No Array of String Notification group ID, a collection of user group IDs. User group IDs can be queried through DescribeUserGroup.
    Example: ["1678\n"]

    3. Output Parameters

    Parameter name Type Description
    AutoScalingPolicyId String ID of the alarm trigger policy.
    Example: asp-iir70sxv
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    ResourceNotFound.AutoScalingGroupIdNotFound The scaling group does not exist.
    InvalidParameterValue.ScalingPolicyNameDuplicate The alarm policy name already exists.
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    InternalError.RequestError Request error