Tenant Cloud Compute Auto Scaling Scaling Group APIs CreateAutoScalingGroup

CreateAutoScalingGroup

Last Updated At: 2026-08-03 00:05:14

1. Interface Description

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

This API (CreateAutoScalingGroup) is used to create an auto scaling group.

Default interface request rate limit: 20 times per second.

Interface update time: 2023-03-03 11:45:31.

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: CreateAutoScalingGroup
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
AutoScalingGroupName Yes No String Name of the scaling group. The name must be unique within your account. The name can contain only letters, digits, underscores (_), hyphens (-), and decimal points (.) and must be up to 55 bytes in length.
Example: asgname
DefaultCooldown No No Uint64 Default cooldown period. Unit: seconds. Default value: 300.
Example: 300
DesiredCapacity No No Uint64 Desired number of instances. The value must be in the range of the minimum number of instances and the maximum number of instances.
Example: 1
LaunchConfigurationId Yes No String Launch Configuration ID
Example: asc-aaaabbbb
LoadBalancerIds No No Array of String IDs of classic load balancers. Up to 20 IDs are supported. You can only specify one of LoadBalancerIds and ForwardLoadBalancers, or leave both of them empty.
Example: ["lb-aaaabbbb"]
MaxSize Yes No Uint64 Maximum number of instances. Valid values: 0 to 2000.
Example: 1
MinSize Yes No Uint64 Minimum number of instances. Valid values: 0 to 2000.
Example: 1
ProjectId No No Uint64 Project ID.
Example: 1
ForwardLoadBalancers No No Array of ForwardLoadBalancer List of application load balancers. Up to 20 IDs are supported. You can only specify one of LoadBalancerIds and ForwardLoadBalancers, or leave both of them empty.
Example:View
SubnetIds No No Array of String IDs of subnets. You must specify subnets in VPC scenarios. Multiple subnets are prioritized in the order in which they are specified and are tried in sequence until an instance can be successfully created.
Example: ["subnet-bh595fp6"]
TerminationPolicies No No Array of String Termination policy. Currently, you can specify up to one termination policy. Valid values: OLDEST_INSTANCE and NEWEST_INSTANCE. Default value: OLDEST_INSTANCE.

  •  OLDEST_INSTANCE: prioritizes the oldest instance in the scaling group.

  •  NEWEST_INSTANCE: prioritizes the newest instance in the scaling group.
    Example: OLDEST_INSTANCE
    		•
    VpcId Yes No String VPC ID. Specify an empty string for a basic network.
    Example: vpc-aaaabbbb
    Zones No No Array of String List of availability zones (AZs). You must specify AZs for a basic network. Multiple AZs are prioritized in the order in which they are specified and are tried in sequence until an instance can be successfully created.
    Example: ["ap-region-1"]
    RetryPolicy No No String Retry policy. Valid values: IMMEDIATE_RETRY, INCREMENTAL_INTERVALS, and NO_RETRY. Valid value: IMMEDIATE_RETRY.

  •  IMMEDIATE_RETRY: retries in a short period and stops retrying after five consecutive failed attempts.

  •  INCREMENTAL_INTERVALS: the retry interval increases as the number of consecutive failures increases. The retry interval ranges from seconds to one day.

  •  NO_RETRY: no retry until a user call or alarm message is received again.
    Example: IMMEDIATE_RETRY
    		•
    ZonesCheckPolicy No No String Availability zone verification policy. Valid values include ALL and ANY. Default value: ANY.

  •  ALL: the verification is successful only if all availability zones and subnets are available. Otherwise, the verification fails.

  •  ANY: the verification is successful if one of the availability zones or subnets is available. Otherwise, the verification fails.

    Common reasons why an AZ or subnet is unavailable include: the CVM instance types in the AZ are sold out, the CBS disks in the AZ are sold out, the quota in the AZ is insufficient, and the IP addresses in the subnet are insufficient.
    If the AZs specified in the Zones parameter or the subnets specified in the SubnetIds parameter do not exist, the verification fails regardless of the value of the ZonesCheckPolicy parameter.
    Example: ALL
    		•
    Tags No No Array of Tag Tag list. You can use this parameter to bind tags to the scaling group and bind these tags to the corresponding resource instances.
    Example:View
    ServiceSettings No No ServiceSettings Service settings, including unhealthy instance replacement.
    Example:View
    Ipv6AddressCount No No Int64 Configuration of the instance with the quantity of IPv6 addresses, values include 0 and 1. The default value is 0.
    Example: 1

    3. Output Parameters

    Parameter name Type Description
    AutoScalingGroupId String ID of the scaling group.
    Example: asg-aaaaqqqq
    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
    InvalidParameterValue.OnlyVpc The account only supports VPCs.
    InvalidParameter.InScenario The parameter is invalid in a specific scenario.
    InvalidParameterValue.LbProjectInconsistent The load balancer is in a different project.
    InvalidParameterValue.Range The value is outside the specified range.
    InvalidParameterValue.TooLong Too many values.
    ResourceUnavailable.ProjectInconsistent Project inconsistency.
    InvalidParameterValue.GroupNameDuplicated The auto scaling group name already exists.
    LimitExceeded.AutoScalingGroupLimitExceeded The number of auto scaling groups exceeds the limit.
    LimitExceeded.MaxSizeLimitExceeded The maximum number of instances exceeds the limit.
    InvalidParameterValue.Size The value of maximum, minimum, or desired number of instances in the auto scaling group is invalid.
    InvalidParameterValue.LbVpcInconsistent The load balancer and the scaling group are in different VPCs.
    LimitExceeded.MinSizeLimitExceeded The minimum number of instances is below the limit.
    LimitExceeded The quota limit is exceeded.
    InvalidParameterValue.CvmError Exception with CVM parameter validation.
    InvalidParameterValue.LaunchConfigurationNotFound The specified launch configuration was not found.
    InvalidParameterValue.SubnetIds The subnet information is invalid.
    MissingParameter.InScenario A parameter is missing in a specific scenario.
    ResourceUnavailable.LaunchConfigurationStatusAbnormal The launch configuration is exceptional.
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    InternalError Internal error.
    InvalidParameterValue.ForwardLb The application load balancer is incorrectly specified.
    ResourceNotFound.LoadBalancerNotFound The specified load balancer was not found.