All Products
Search

This Product

    Auto Scaling:CreateScalingConfiguration

    Document Center

    Auto Scaling:CreateScalingConfiguration

    Last Updated:Jul 02, 2026

    Creates an ECS-type scaling configuration for a scaling group by calling the CreateScalingConfiguration operation and specifying information such as the scaling group ID, instance type, and instance image.

    Operation description

    A scaling configuration specifies the ECS instance template used for elastic scale-out. The following instance configuration methods are supported:

    • InstancePatternInfos: intelligent configuration mode. You do not need to specify specific instance types. Instead, you specify the number of vCPU cores, memory size, instance family level, and maximum price based on your business requirements. The system automatically filters instance types that meet the requirements and preferentially selects the instance type with the lowest price to create ECS instances. This mode applies only to scaling groups whose network type is VPC and can effectively reduce the risk of insufficient inventory of instance types during scale-out.

    • InstanceType: specifies a single instance type.

    • InstanceTypes: specifies multiple instance types.

    • InstanceTypeOverrides: specifies multiple instance types and configures weights for different instance types.

    • Cpu and Memory: specifies the range of instance types by defining CPU and memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zone, and creates instances with the lowest price sorted by price. This method applies only when the scaling policy of the scaling group is cost optimization and no instance type is specified in the scaling configuration.

    • You can bind a primary network interface card (NIC) by using either of the following methods. However, you can use only one method in a single request. If you use both methods, the call fails and an error message is returned.

      • Use parameters such as SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount to directly configure the primary NIC.

      • Use NetworkInterfaces to configure both the primary NIC and secondary NICs. When you use the NetworkInterface parameter, you must configure the primary NIC. If NetworkInterface.InstanceType is set to Primary, the primary NIC is configured. If NetworkInterface.InstanceType is set to Secondary or left empty, a secondary NIC is configured.

    Note

    The four methods InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory cannot be specified at the same time. However, InstanceType or InstanceTypes can be specified together with InstancePatternInfos. When specified together with InstancePatternInfos, Auto Scaling preferentially uses the instance types you specified for scale-out. If the specified instance types are out of stock, instance types that match the InstancePatternInfos configuration are used.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ess:CreateScalingConfiguration

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ScalingGroupId

    string

    Yes

    The ID of the scaling group to which the scaling configuration belongs.

    asg-bp14wlu85wrpchm0****
    ImageId

    string

    No

    The ID of the image file used for automatic creation of instances.

    centos6u5_64_20G_aliaegis****.vhd
    ImageName

    string

    No

    The name of the image file. Image names are unique within a region. If you set ImageId, ImageName is ignored.

    You cannot use ImageName to specify images from Alibaba Cloud Marketplace.

    image****
    InstanceType

    string

    No

    The instance type of the ECS instance. For more information, see Instance families.

    ecs.g6.large
    Cpu

    integer

    No

    The number of vCPUs. Unit: cores.

    Specifying both CPU and Memory defines the range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zone, and creates instances with the lowest price sorted by price.

    Note

    This range configuration takes effect only in cost optimization mode when no instance type is specified in the scaling configuration.

    2
    Memory

    integer

    No

    The memory size. Unit: GiB.

    Specifying both CPU and Memory defines the range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zone, and creates instances with the lowest price sorted by price.

    Note

    This range configuration takes effect only in cost optimization mode when no instance type is specified in the scaling configuration.

    16
    DeploymentSetId

    string

    No

    The ID of the deployment set to which the ECS instance belongs.

    ds-bp1frxuzdg87zh4pz****
    SecurityGroupId

    string

    No

    The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other.

    sg-280ih****
    IoOptimized

    string

    No

    Specifies whether the instance is an I/O optimized instance. Valid values:

    none: non-I/O optimized instance. optimized: I/O optimized instance.

    The default value for retired instance types is none. The default value for other instance types is optimized.

    optimized
    InternetChargeType

    string

    No

    The billing method for network usage. Valid values:

    • PayByBandwidth: pay-by-bandwidth. The value of InternetMaxBandwidthOut is used as the fixed bandwidth value.

    • PayByTraffic: pay-by-traffic. The value of InternetMaxBandwidthOut is used as the maximum bandwidth. Billing is based on the actual network traffic.

    If this parameter is not specified, the default value is PayByBandwidth for the classic network and PayByTraffic for VPCs.

    PayByTraffic
    InternetMaxBandwidthIn

    integer

    No

    The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:

    • If the maximum outbound public bandwidth is less than or equal to 10 Mbit/s: 1 to 10. Default value: 10.

    • If the maximum outbound public bandwidth is greater than 10 Mbit/s: 1 to the value of InternetMaxBandwidthOut. Default value: the value of InternetMaxBandwidthOut.

    10
    InternetMaxBandwidthOut

    integer

    No

    The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.

    Default value: 0.

    10
    SystemDisk.Category

    string

    No

    The category of the system cloud disk. Valid values:

    • cloud: basic cloud disk.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • ephemeral_ssd: local SSD.

    • cloud_essd: enhanced SSD (ESSD).

    • cloud_auto: ESSD AutoPL cloud disk.

    This parameter cannot be specified together with SystemDiskCategories. If neither this parameter nor SystemDiskCategories is specified, the default value is used:

    • For I/O optimized instances, the default value is cloud_efficiency.

    • For non-I/O optimized instances, the default value is cloud.

    cloud_ssd
    SystemDisk.Size

    integer

    No

    The size of the system cloud disk. Unit: GiB. Valid values:

    • Basic cloud disk: 20 to 500.

    • ESSD:

      • PL0: 1 to 2048.

      • PL1: 20 to 2048.

      • PL2: 461 to 2048.

      • PL3: 1261 to 2048.

    • ESSD AutoPL cloud disk: 1 to 2048.

    • Other cloud disk types: 20 to 2048.

    The value of this parameter must be greater than or equal to max{1, ImageSize}.

    Default value: max{40, ImageSize}.

    100
    SystemDisk.DiskName

    string

    No

    The name of the system cloud disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character and cannot start with http:// or https://.

    cloud_ssdSystem
    SystemDisk.Description

    string

    No

    The description of the system cloud disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    Test system disk.
    SystemDisk.AutoSnapshotPolicyId

    string

    No

    The ID of the automatic snapshot policy applied to the system cloud disk.

    sp-bp12m37ccmxvbmi5****
    SystemDisk.PerformanceLevel

    string

    No

    The performance level (PL) of the system cloud disk when the disk is an ESSD. Valid values:

    • PL0: a single disk can deliver up to 10,000 random read/write IOPS.

    • PL1: a single disk can deliver up to 50,000 random read/write IOPS.

    • PL2: a single disk can deliver up to 100,000 random read/write IOPS.

    • PL3: a single disk can deliver up to 1,000,000 random read/write IOPS.

    Default value: PL1.

    PL0
    ScalingConfigurationName

    string

    No

    The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a digit, letter, or Chinese character.

    The scaling configuration name must be unique within a scaling group in the same region. If you do not specify this parameter, the scaling configuration ID is used by default.

    scalingconfig****
    LoadBalancerWeight

    integer

    No

    The weight of the ECS instance as a backend server of the associated load balancing instance. Valid values: 1 to 100.

    Default value: 50.

    50
    Tags

    string

    No

    The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The following limits apply to Key and Value:

    • Key can be up to 64 characters in length and cannot start with aliyun or acs:, or contain http:// or https://. Key cannot be an empty string.

    • Value can be up to 128 characters in length and cannot start with aliyun or acs:, or contain http:// or https://. Value can be an empty string.

    {"key1":"value1","key2":"value2", ... "key5":"value5"}
    UserData

    string

    No

    The user data of the ECS instance. The data must be Base64-encoded. The maximum size of the raw data before encoding is 32 KB.

    ZWNobyBoZWxsbyBlY3Mh
    KeyPairName

    string

    No

    The name of the key pair used to log on to the ECS instance.

    • For Windows instances, this parameter is ignored and is empty by default.

    • For Linux instances, password-based logon is disabled during initialization.

    KeyPairTest
    RamRoleName

    string

    No

    The name of the RAM role associated with the ECS instance. The RAM role name is provided and maintained by Resource Access Management (RAM). You can call ListRoles to query available RAM roles.

    ramrole****
    SecurityEnhancementStrategy

    string

    No

    Specifies whether to enable security hardening. Valid values:

    • Active: enables security hardening. This value is applicable only to public images.

    • Deactive: disables security hardening. This value is applicable to all image types.

    Active
    InstanceName

    string

    No

    The name of the ECS instance that is automatically created by using this scaling configuration.

    instance****
    HostName

    string

    No

    The hostname of the ECS instance. A period (.) or hyphen (-) cannot be used as the first or last character, and consecutive periods (.) or hyphens (-) are not allowed. Naming conventions vary by instance type:

    • Windows instances: The hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or be composed entirely of digits.

    • Other instances (such as Linux): The hostname must be 2 to 64 characters in length and can contain multiple periods (.). Each segment between two periods (.) can contain letters, digits, and hyphens (-).

    host****
    SpotStrategy

    string

    No

    The preemption policy for pay-as-you-go instances. Valid values:

    • NoSpot: a regular pay-as-you-go instance.

    • SpotWithPriceLimit: a spot instance with a user-defined maximum hourly price.

    • SpotAsPriceGo: a spot instance priced at the market price at the time of purchase.

    Default value: NoSpot.

    NoSpot
    PasswordInherit

    boolean

    No

    Specifies whether to use the password preset in the image. To use this parameter, make sure that a password is configured for the image. Valid values:

    • true: uses the password preset in the image.

    • false: does not use the password preset in the image.

    false
    Password

    string

    No

    The password of the ECS instance. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:

    `() ~!@#$%^&*-_+=\|{}[]:;'<>,.?/

    For Windows instances, the password cannot start with a forward slash (/).

    Note

    If you specify the Password parameter, use HTTPS to send the request to avoid password leaks.

    123abc****
    ResourceGroupId

    string

    No

    The ID of the resource group to which the ECS instance belongs.

    rg-resource****
    HpcClusterId

    string

    No

    The ID of the HPC cluster to which the ECS instance belongs.

    hpc-clusterid
    InstanceDescription

    string

    No

    The description of the ECS instance. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    Test instance.
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    123e4567-e89b-12d3-a456-42665544****
    Ipv6AddressCount

    integer

    No

    The number of randomly generated IPv6 addresses allocated to the elastic network interface (ENI).

    1
    CreditSpecification

    string

    No

    The running pattern of the burstable instance. Valid values:

    • Standard: standard mode.

    • Unlimited: unlimited mode.

    For more information, see the performance mode section in Overview of burstable instances.

    Standard
    ImageFamily

    string

    No

    The name of the image family. If you set this parameter, the latest available image in the specified image family is used to create instances. If you set ImageId, you cannot set this parameter.

    hangzhou-daily-update
    ZoneId

    string

    No

    The zone ID of the ECS instance.

    cn-hangzhou-g
    DedicatedHostId

    string

    No

    Specifies whether to create the ECS instance on a dedicated host. Because dedicated hosts do not support the creation of spot instances, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored when DedicatedHostId is specified.

    You can call DescribeDedicatedHosts to query the list of dedicated host IDs.

    dh-bp67acfmxazb4p****
    Affinity

    string

    No

    Specifies whether the instance on a dedicated host is associated with the dedicated host. Valid values:

    • default: the instance is not associated with the dedicated host. When an instance that has the economical mode enabled is restarted, the instance may be placed on another dedicated host in the automatic deployment resource pool if the original dedicated host has insufficient available resources.

    • host: the instance is associated with the dedicated host. When an instance that has the economical mode enabled is restarted, the instance remains on the original dedicated host. If the original dedicated host has insufficient available resources, the instance fails to restart.

    Default value: default.

    default
    Tenancy

    string

    No

    Specifies whether to create the instance on a dedicated host. Valid values:

    • default: creates a non-dedicated host instance.

    • host: creates a dedicated host instance. If you do not specify DedicatedHostId, Alibaba Cloud automatically selects a dedicated host for the instance.

    Default value: default.

    default
    SchedulerOptions

    object

    No

    The scheduler options.

    ["testManagedPrivateSpaceId****"]
    PrivatePoolOptions.MatchCriteria

    string

    No

    The private pool option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instances to use at startup. Valid values:

    • Open: open mode. The system automatically matches open private pools. If no matching private pool is available, public pool resources are used. You do not need to set the PrivatePoolOptions.Id parameter in this mode.

    • Target: specified mode. A specified private pool is used to start the instance. If the specified private pool is unavailable, the instance fails to start. In this mode, you must specify the private pool ID, which means the PrivatePoolOptions.Id parameter is required.

    • None: none mode. Private pools are not used for instance startup.

    Open
    PrivatePoolOptions.Id

    string

    No

    The private pool ID, which is the ID of the elasticity assurance or capacity reservation.

    eap-bp67acfmxazb4****
    SpotDuration

    integer

    No

    The protection period of the spot instance. Unit: hours. Valid values:

    • 1: After the instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After 1 hour, the system automatically compares the bid price with the market price and checks the resource inventory to determine whether to retain automatic release the instance.

    • 0: After the instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system automatically compares the bid price with the market price and checks the resource inventory to determine whether to retain automatic release the instance.

    Note

    Alibaba Cloud sends an ECS system event notification 5 minutes before the instance is released. Spot instances are billed by second. We recommend that you select an appropriate protection period based on the expected task execution duration.

    Default value: 1.

    1
    SpotInterruptionBehavior

    string

    No

    The interruption mode of the spot instance. Only terminate (default) is supported, which directly releases the instance.

    Terminate
    InstanceTypes

    array

    No

    The instance types. If InstanceTypes is specified, InstanceType is ignored.

    If an instance cannot be created based on a higher-priority instance type, Auto Scaling automatically selects the next-priority instance type to create the instance.

    string

    No

    The instance types. If InstanceTypes is specified, InstanceType is ignored.

    If an instance cannot be created based on a higher-priority instance type, Auto Scaling automatically selects the next-priority instance type to create the instance.

    ecs.g6.large
    InstanceTypeOverrides

    array<object>

    No

    The information about the specified instance types.

    object

    No

    The information about the specified instance types.

    InstanceType

    string

    No

    If you want the scaling group to scale based on the capacity of instance types, specify both this parameter and WeightedCapacity.

    This parameter specifies ECS instance type and overrides ECS instance type in the launch template. You can specify N instance types to extend the launch template to support N instance types. Valid values of N: 1 to 20.

    Note

    This parameter takes effect only when the LaunchTemplateId parameter specifies a launch template.

    Valid values of InstanceType: instance types that are available for purchase.

    ecs.c5.xlarge
    WeightedCapacity

    integer

    No

    If you want to specify the capacity of instance types in the scaling configuration, specify this parameter after you specify InstanceTypeOverrides.InstanceType.

    This parameter specifies the weight of the instance type, which represents the capacity of a single instance of this type in the scaling group. A larger weight means fewer instances of this type are required to meet the expected capacity.

    Because instance types differ in the number of vCPUs, memory size, and other performance metrics, you can configure different weights for different instance types based on your requirements.

    Example:

    • Current capacity: 0.

    • Expected number of instances: 6.

    • Capacity of ecs.c5.xlarge: 4.

    To meet the expected capacity, the scaling group scales out 2 ecs.c5.xlarge instances.

    Note

    During scale-out, the capacity of the scaling group cannot exceed the sum of the maximum capacity (MaxSize) and the maximum weight of the instance types.

    Valid values of WeightedCapacity: 1 to 500.

    4
    DataDisks

    array<object>

    No

    The collection of data cloud disk information.

    object

    No

    The collection of data cloud disk information.

    PerformanceLevel

    string

    No

    The performance level (PL) of the data cloud disk when the disk is an ESSD. Valid values:

    • PL0: a single disk can deliver up to 10,000 random read/write IOPS.

    • PL1: a single disk can deliver up to 50,000 random read/write IOPS.

    • PL2: a single disk can deliver up to 100,000 random read/write IOPS.

    • PL3: a single disk can deliver up to 1,000,000 random read/write IOPS.

    Note

    For information about how to select an ESSD performance level, see ESSDs.

    PL0
    AutoSnapshotPolicyId

    string

    No

    The ID of the automatic snapshot policy applied to the data cloud disk.

    sp-bp19nq9enxqkomib****
    Encrypted

    string

    No

    Specifies whether to encrypt the data cloud disk. Valid values:

    • true: encrypts the data cloud disk.

    • false: does not encrypt the data cloud disk.

    Default value: false.

    false
    Description

    string

    No

    The description of the data cloud disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    Test data disk.

    SnapshotId

    string

    No

    The ID of the snapshot used to create the data cloud disk. If this parameter is specified, DataDisks.Size is ignored, and the size of the created disk is the size of the specified snapshot.

    If the snapshot was created on or before July 15, 2013, the call is rejected and the error message InvalidSnapshot.TooOld is returned.

    s-280s7****
    Categories

    array

    No

    The disk types of the data cloud disk. If the disk type with a higher priority cannot be used, Auto Scaling automatically tries the next-priority disk type to create the data cloud disk. Valid values:

    • cloud: basic cloud disk. The DeleteWithInstance property of a basic cloud disk created together with the instance is set to true.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • ephemeral_ssd: local SSD.

    • cloud_auto: ESSD AutoPL cloud disk.

    • cloud_regional_disk_auto: regional ESSD.

    Note

    If you specify this parameter, you cannot specify DataDisks.Category at the same time.

    string

    No

    The disk types of the data cloud disk. If the disk type with a higher priority cannot be used, Auto Scaling automatically tries the next-priority disk type to create the data cloud disk. Valid values:

    • cloud: basic cloud disk. The DeleteWithInstance property of a basic cloud disk created together with the instance is set to true.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • ephemeral_ssd: local SSD.

    • cloud_auto: ESSD AutoPL cloud disk.

    • cloud_regional_disk_auto: regional ESSD.

    Note

    If you specify this parameter, you cannot specify DataDisks.Category at the same time.

    cloud
    Size

    integer

    No

    The size of the data cloud disk. Unit: GiB. Valid values:

    • cloud: 5 to 2000.

    • cloud_efficiency: 20 to 32768.

    • cloud_essd: 20 to 32768.

    • ephemeral_ssd: 5 to 800.

    If this parameter is specified, the disk size must be greater than or equal to the snapshot size (the snapshot is specified by SnapshotId).

    100
    Device

    string

    No

    The mount point of the data cloud disk. If you do not specify this parameter, the mount point is allocated by the system by default during automatic creation of the ECS instance. The mount points range from /dev/xvdb to /dev/xvdz.

    /dev/xvdb
    DiskName

    string

    No

    The name of the data cloud disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character and cannot start with http:// or https://.

    cloud_ssdData
    Category

    string

    No

    The category of the data cloud disk. Valid values:

    • cloud: basic cloud disk. The DeleteWithInstance property of a basic cloud disk created together with the instance is set to true.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • ephemeral_ssd: local SSD.

    • cloud_auto: ESSD AutoPL cloud disk.

    • cloud_regional_disk_auto: regional ESSD.

    This parameter cannot be specified together with DataDisk.Categories. If neither this parameter nor DataDisk.Categories is specified, the default value is used:

    • For I/O optimized instances, the default value is cloud_efficiency.

    • For non-I/O optimized instances, the default value is cloud.

    cloud_ssd
    DeleteWithInstance

    boolean

    No

    Specifies whether to release the data cloud disk when the instance is released. Valid values:

    • true: releases the data cloud disk when the instance is released.

    • false: retains the data cloud disk when the instance is released.

    This parameter can be set only for independent cloud disks (DataDisks.Category is set to cloud, cloud_efficiency, cloud_ssd, or cloud_essd). Otherwise, an error is returned.

    Default value: true.

    true
    KMSKeyId

    string

    No

    The ID of the KMS key for the data cloud disk.

    0e478b7a-4262-4802-b8cb-00d3fb40****
    ProvisionedIops

    integer

    No

    The provisioned IOPS (Input/Output Operations Per Second) performance metric of the data cloud disk.

    Note

    IOPS (Input/Output Operations Per Second) measures the number of read/write (output/input) operations that block storage can process per second.

    100
    BurstingEnabled

    boolean

    No

    Specifies whether to enable the burst (performance burst) feature for the system cloud disk. Valid values:

    • true: enables the feature.

    • false: does not enable the feature.

    Note

    This parameter is supported only when SystemDisk.Category is set to cloud_auto.

    false
    SpotPriceLimits

    array<object>

    No

    The collection of billing information for spot instances.

    object

    No

    The collection of billing information for spot instances.

    PriceLimit

    number

    No

    The bid price for the spot instance. This parameter takes effect when SpotStrategy is set to SpotWithPriceLimit.

    0.5
    InstanceType

    string

    No

    The instance type of the spot instance. This parameter takes effect when SpotStrategy is set to SpotWithPriceLimit.

    ecs.g6.large
    SecurityGroupIds

    array

    No

    The IDs of the security groups to which the ECS instance is added. For more information, see the security group section in Limits.

    Note

    You cannot specify both SecurityGroupId and SecurityGroupIds.

    string

    No

    The IDs of the security groups to which the ECS instance is added. For more information, see the security group section in Limits.

    Note

    You cannot specify both SecurityGroupId and SecurityGroupIds.

    sg-bp18kz60mefs****
    InstancePatternInfos

    array<object>

    No

    The collection of intelligent configuration information used to filter instance types that meet the requirements.

    object

    No

    The collection of intelligent configuration information used to filter instance types that meet the requirements.

    Cores

    integer

    No

    The number of vCPU cores of the instance type in intelligent configuration mode, used to filter instance types that meet the requirements. For more information, see Instance families.

    Note the following information:

    • The InstancePatternInfos parameter applies only to scaling groups whose network type is VPC.

    • You must specify both InstancePatternInfos.Cores and InstancePatternInfos.Memory for the InstancePatternInfos parameter.

    • If you have specified instance types by using the InstanceType or InstanceTypes parameter, Auto Scaling preferentially uses the specified instance types for scale-out. If the specified instance types are out of stock, Auto Scaling uses the instance type with the lowest price among the instance types that match the InstancePatternInfos parameter values for scale-out.

    2
    InstanceFamilyLevel

    string

    No

    The level of the instance family, used to filter instance types that meet the requirements. This parameter takes effect when CostOptimization is enabled. Valid values:

    • EntryLevel: entry level, which refers to shared instance types. These instance types are more cost-effective but cannot guarantee stable computing performance. They are suitable for scenarios with low CPU utilization. For more information, see Shared instance families.

    • EnterpriseLevel: enterprise level. These instance types provide stable performance and dedicated resources, and are suitable for scenarios that require high stability. For more information, see Instance families.

    • CreditEntryLevel: credit-based entry level, which refers to burstable instances. These instance types use CPU credits to ensure computing performance and are suitable for scenarios with low average CPU utilization and occasional bursts. For more information, see Overview of burstable instances.

    EnterpriseLevel
    MaxPrice

    number

    No

    The maximum hourly price for pay-as-you-go or spot instances in intelligent configuration mode, used to filter instance types that meet the requirements.

    Note

    This parameter is required when SpotStrategy is set to SpotWithPriceLimit. In other cases, this parameter is optional.

    2
    Memory

    number

    No

    The memory size of the instance type in intelligent configuration mode. Unit: GiB. This parameter is used to filter instance types that meet the requirements.

    4
    ExcludedInstanceTypes

    array

    No

    The instance types to exclude. You can use wildcard characters (*) to exclude a single instance type or an entire instance family. Examples:

    • ecs.c6.large: excludes the ecs.c6.large instance type.

    • ecs.c6.*: excludes the entire c6 instance family.

    string

    No

    The instance types to exclude. You can use wildcard characters (*) to exclude a single instance type or an entire instance family. Examples:

    • ecs.c6.large: excludes the ecs.c6.large instance type.

    • ecs.c6.*: excludes the entire c6 instance family.

    ecs.n1.small/ecs.n1.*/*7*
    Architectures

    array

    No

    The architecture types of the instance type. Valid values:

    • X86: X86 computing.

    • Heterogeneous: heterogeneous computing, such as GPU or FPGA.

    • BareMental: ECS Bare Metal Instance server.

    • Arm: Arm computing.

    Default value: all architecture types are included.

    string

    No

    The architecture types of the instance type. Valid values:

    • X86: X86 computing.

    • Heterogeneous: heterogeneous computing, such as GPU or FPGA.

    • BareMental: ECS Bare Metal Instance server.

    • Arm: Arm computing.

    Default value: all architecture types are included.

    X86
    BurstablePerformance

    string

    No

    Specifies whether to include burstable instance types. Valid values:

    • Exclude: excludes burstable instance types.

    • Include: includes burstable instance types.

    • Required: includes only burstable instance types.

    Default value: Include.

    Include
    InstanceTypeFamilies

    array

    No

    The instance families to query. N indicates that you can specify multiple instance families. Valid values of N: 1 to 10.

    string

    No

    The instance families to query. N indicates that you can specify multiple instance families. Valid values of N: 1 to 10.

    ecs.g6
    MinimumCpuCoreCount

    integer

    No

    The minimum number of vCPU cores of the instance type.

    2
    MaximumCpuCoreCount

    integer

    No

    The maximum number of vCPU cores of the instance type.

    Note

    MaximumCpuCoreCount cannot exceed 4 times the value of MinimumCpuCoreCount.

    4
    GpuSpecs

    array

    No

    The GPU type.

    string

    No

    The GPU type.

    NVIDIA V100
    InstanceCategories

    array

    No

    The instance categorization. Valid values:

    Note

    N specifies that you can set multiple instance categories. Valid values of N: 1 to 10.

    • General-purpose: general-purpose

    • Compute-optimized: compute-optimized

    • Memory-optimized: memory-optimized

    • Big data: big data

    • Local SSDs: local SSD

    • High Clock Speed: high frequency

    • Enhanced: enhanced

    • Shared: shared

    • Compute-optimized with GPU: GPU computing

    • Visual Compute-optimized: visual compute-optimized

    • Heterogeneous Service: heterogeneous service

    • Compute-optimized with FPGA: FPGA-accelerated compute-optimized

    • Compute-optimized with NPU: NPU-accelerated compute-optimized

    • ECS Bare Metal: Elastic Compute Service Bare Metal server

    • High Performance Compute: high-performance computing (HPC)

    string

    No

    The instance categorization. Valid values:

    Note

    N specifies that you can set multiple instance type categories. Valid values of N: 1 to 10.

    • General-purpose: general-purpose

    • Compute-optimized: compute-optimized

    • Memory-optimized: memory-optimized

    • Big data: big data

    • Local SSDs: local SSD

    • High Clock Speed: high frequency

    • Enhanced: enhanced

    • Shared: shared

    • Compute-optimized with GPU: GPU computing

    • Visual Compute-optimized: visual compute-optimized

    • Heterogeneous Service: heterogeneous service

    • Compute-optimized with FPGA: FPGA-accelerated compute-optimized

    • Compute-optimized with NPU: NPU-accelerated compute-optimized

    • ECS Bare Metal: Elastic Compute Service Bare Metal server

    • High Performance Compute: high-performance computing (HPC)

    Compute-optimized with GPU
    CpuArchitectures

    array

    No

    The CPU architectures of the instance. Valid values:

    Note

    N indicates that you can specify multiple CPU architectures. Valid values of N: 1 to 2.

    • X86.

    • ARM.

    string

    No

    The CPU architectures of the instance. Valid values:

    Note

    N indicates that you can specify multiple CPU architectures. Valid values of N: 1 to 2.

    • X86.

    • ARM.

    X86
    PhysicalProcessorModels

    array

    No

    The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10. [_single.params

    string

    No

    The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10. [_single.params

    Intel Xeon(Ice Lake) Platinum 8369B
    MinimumEniQuantity

    integer

    No

    The minimum number of elastic network interfaces (ENIs) that can be attached to an instance.

    2
    MinimumEniPrivateIpAddressQuantity

    integer

    No

    The minimum number of IPv4 addresses that can be assigned to a single elastic network interface (ENI) of an instance.

    2
    MinimumEniIpv6AddressQuantity

    integer

    No

    The minimum number of IPv6 addresses that can be assigned to a single elastic network interface (ENI) of an instance.

    1
    MinimumInitialCredit

    integer

    No

    The minimum initial vCPU credits for burstable instances (t5 and t6).

    12
    MinimumBaselineCredit

    integer

    No

    The minimum baseline vCPU computing performance of burstable instances (t5 and t6), which is the sum of all vCPUs.

    12
    MinimumMemorySize

    number

    No

    The minimum memory size of the instance. Unit: GiB.

    4
    MaximumMemorySize

    number

    No

    The maximum memory size of the instance. Unit: GiB.

    4
    MinimumGpuAmount

    integer

    No

    The minimum number of GPUs of the instance. Valid values: positive integers.

    2
    MaximumGpuAmount

    integer

    No

    The maximum number of GPUs of the instance. Valid values: positive integers.

    2
    SystemDiskCategories

    array

    No

    The multiple disk types for the system cloud disk. If the disk type with a higher priority is unavailable, Auto Scaling automatically tries the disk type with the next priority to create the system cloud disk. Valid values:

    • cloud: basic cloud disk.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: Enterprise SSD (ESSD).

    Note

    If you specify this parameter, you cannot specify SystemDisk.Category at the same time.

    string

    No

    The multiple disk types for the system cloud disk. If the disk type with a higher priority is unavailable, Auto Scaling automatically tries the disk type with the next priority to create the system cloud disk. Valid values:

    • cloud: basic cloud disk.

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: Enterprise SSD (ESSD).

    Note

    If you specify this parameter, you cannot specify SystemDisk.Category at the same time.

    cloud
    SystemDisk.Encrypted

    boolean

    No

    Specifies whether to encrypt the system cloud disk. Valid values:

    • true: Encrypted.

    • false: Not encrypted.

    Default value: false.

    false
    SystemDisk.KMSKeyId

    string

    No

    The ID of the KMS key used for the system cloud disk.

    0e478b7a-4262-4802-b8cb-00d3fb40****
    SystemDisk.EncryptAlgorithm

    string

    No

    The encryption algorithm used for the system cloud disk. Valid values:

    • AES-256

    • SM4-128

    Default value: AES-256.

    AES-256
    SystemDisk.ProvisionedIops

    integer

    No

    The provisioned IOPS (Input/Output Operations Per Second) performance metrics for the system cloud disk.

    Note

    IOPS (Input/Output Operations Per Second) measures the number of read and write (output/input) operations that block storage can process per second.

    100
    SystemDisk.BurstingEnabled

    boolean

    No

    Specifies whether to enable the Burst (performance burst) feature for the system cloud disk. Valid values:

    • true: Enabled.

    • false: Not enabled.

    Note

    This parameter is supported only when SystemDisk.Category is set to cloud_auto.

    false
    ImageOptions.LoginAsNonRoot

    boolean

    No

    Specifies whether the ECS instance uses the ecs-user account for logon. For more information, see Manage the logon name of an ECS instance. Valid values:

    • true: Yes.

    • false: No.

    Default value: false.

    false
    DeletionProtection

    boolean

    No

    Specifies whether to enable release protection for the instance. This parameter specifies whether the instance can be directly released from the ECS console or by calling the DeleteInstance operation, which prevents the instance from being accidentally deleted. Valid values:

    • true: Enables release protection. The instance cannot be directly released from the ECS console or by calling the DeleteInstance operation.

    • false: Disables release protection. The instance can be directly released from the ECS console or by calling the DeleteInstance operation.

    Default value: false.

    Note

    This property applies only to pay-as-you-go instances. It prevents instances created by Auto Scaling scale-out activities from being accidentally deleted, but does not affect normal scale-in activities. Instances with release protection enabled can still be released by scale-in activities.

    false
    StorageSetId

    string

    No

    The ID of the dedicated block storage cluster.

    ss-bp67acfmxazb4p****
    StorageSetPartitionNumber

    integer

    No

    The maximum number of partitions in the dedicated block storage cluster. Valid values: greater than or equal to 2.

    2
    CustomPriorities

    array<object>

    No

    The custom priorities for ECS instance type and vSwitch combinations.

    Important This parameter takes effect only when the scaling policy of the scaling group is set to priority-based policy.

    If an instance cannot be created based on the instance type and vSwitch combination with a higher priority, Auto Scaling automatically selects the combination with the next priority to create the instance.

    Note

    If you specify custom priorities for only some instance type and vSwitch combinations, the unspecified combinations have lower priorities than the specified ones. The unspecified combinations are still prioritized based on the vSwitch order of the scaling group and the instance type order of the scaling configuration.

    • For example, if the vSwitch order of the scaling group is vsw1 and vsw2, the instance type order of the scaling configuration is type1 and type2, and the custom priority order is ["vsw2+type2", "vsw1+type2"], the final priority is: "vsw2+type2" > "vsw1+type2" > "vsw1+type1" > "vsw2+type1".

    object

    No

    InstanceType

    string

    No

    The instance type of the ECS instance.

    Important The instance type must be included in the instance type list of the scaling configuration.

    ecs.g6.large
    VswitchId

    string

    No

    The ID of the vSwitch.

    Important The vSwitch must be included in the vSwitch list of the scaling group.

    vsw-bp14zolna43z266bq****
    NetworkInterfaces

    array<object>

    No

    The list of elastic network interfaces (ENIs).

    object

    No

    The elastic network interface (ENI).

    InstanceType

    string

    No

    The type of the elastic network interface (ENI). If you use this parameter, you must use NetworkInterfaces to set the primary network interface controller (NIC). You cannot set SecurityGroupId or SecurityGroupIds at the same time. Valid values:

    • Primary: primary NIC.

    • Secondary: secondary NIC.

    Default value: Secondary.

    Primary
    NetworkInterfaceTrafficMode

    string

    No

    The communication mode of the network interface controller (NIC). Valid values:

    • Standard: uses the TCP communication mode.

    • HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.

    Default value: Standard.

    Note

    The number of elastic network interfaces (ENIs) in RDMA mode cannot exceed the limit of the instance family. For more information, see Instance families.

    HighPerformance
    Ipv6AddressCount

    integer

    No

    The number of randomly generated IPv6 addresses for the primary ENI. Note:

    • This parameter takes effect only when NetworkInterface.InstanceType is set to Primary. If NetworkInterface.InstanceType is set to Secondary or left empty, you cannot specify this parameter.

    • After you specify this parameter, you cannot specify Ipv6AddressCount.

    1
    SecurityGroupIds

    array

    No

    The IDs of one or more security groups to which the elastic network interface (ENI) belongs.

    string

    No

    The IDs of one or more security groups to which the elastic network interface (ENI) belongs. Note:

    • If NetworkInterface.InstanceType is set to Primary, you must set this parameter. In this case, this parameter has the same effect as SecurityGroupIds, but you cannot set SecurityGroupId or SecurityGroupIds again.

    • If NetworkInterface.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the security group of the ECS instance, which is the security group of the primary network interface controller (NIC).

    sg-uf6ij8dwxxxxxx
    SecondaryPrivateIpAddressCount

    integer

    No

    The number of secondary private IPv4 addresses to assign to the ENI. Valid values: 1 to 49.

    • The value cannot exceed the limit on the number of IP addresses for the instance type. For more information, see Instance families.

    • NetworkInterface.N.SecondaryPrivateIpAddressCount specifies the number of secondary private IPv4 addresses to assign to the ENI (excluding the primary private IP address of the ENI). The system randomly assigns IP addresses from the available CIDR block of the vSwitch (NetworkInterface.N.VSwitchId) to which the ENI belongs.

    6
    DedicatedHostClusterId

    string

    No

    The ID of the dedicated host cluster.

    dc-2zedxc67zqzt7lb4****
    SecurityOptions

    object

    No

    The security options.

    ConfidentialComputingMode

    string

    No

    The confidential computing pattern. Valid values:

    TDX
    HttpEndpoint

    string

    No

    Specifies whether to enable the access channel for instance metadata. Valid values:

    • enabled: Enabled.

    • disabled: Disabled.

    Default value: enabled.

    Note

    For information about instance metadata, see Overview of instance metadata.

    enabled
    HttpTokens

    string

    No

    Specifies whether to forcefully use the security-hardened mode (IMDSv2) when accessing instance metadata. Valid values:

    • optional: Does not forcefully use.

    • required: Forcefully uses. After this value is set, instance metadata cannot be accessed in normal mode.

    Default value: optional.

    Note

    For information about instance metadata access modes, see Instance metadata access modes.

    optional
    ResourcePoolOptions

    object

    No

    The resource pool policy used when creating instances. After you specify this parameter, note the following items:

    • This parameter takes effect only when pay-as-you-go instances are created.

    • This parameter cannot be specified together with PrivatePoolOptions.MatchCriteria or PrivatePoolOptions.Id.

    Strategy

    string

    No

    The resource pool includes private pools generated after the elasticity assurance or capacity reservation takes effect, and public pools, which are available for instance startup. Valid values:

    • PrivatePoolFirst: private pool first. If ResourcePoolOptions.PrivatePoolIds is specified or PrivatePoolTags conditions are met, the corresponding private pool is used first. If no private pool is specified or the specified private pool has insufficient capacity, open-type private pools are automatically matched. If no matching private pool is available, the public pool is used to create instances.

    • PrivatePoolOnly: private pool only. You must specify ResourcePoolOptions.PrivatePoolIds. If the specified private pool has insufficient capacity, the instance fails to start.

    • PublicPoolFirst: public pool first. The public pool is used first to create instances. If the public pool has insufficient resources, private pool resources are used as a supplement. Open-type private pools are automatically matched first. If no matching private pool is available, the Target-type private pools specified by ResourcePoolOptions.PrivatePoolIds or matching PrivatePoolTags conditions are used. (This policy is in invitational preview and is not available for use.)

    • None: does not use a resource pool policy.

    Default value: None.

    PrivatePoolFirst
    PrivatePoolIds

    array

    No

    The private pool IDs, which are the elasticity assurance IDs or capacity reservation IDs. Only Target-type private pool IDs can be specified. This parameter cannot be specified together with the PrivatePoolTags parameter.

    string

    No

    The private pool ID, which is the elasticity assurance ID or capacity reservation ID. Only Target-type private pool IDs can be specified. This parameter cannot be specified together with the PrivatePoolTags parameter. Valid values of N: 1 to 20.

    eap-bp67acfmxazb4****
    PrivatePoolTags

    array<object>

    No

    Filters available Target private pools by tags. Valid values of N: 1 to 20. Note:

    • When this parameter is specified, the system filters only the associated Target private pools under the account that match the tags and satisfy the scaling group constraints (such as zone and instance type).

    • Tag matching rule: a private pool must match all specified tags.

    • This parameter cannot be specified together with the PrivatePoolIds parameter.

    object

    No

    Filters available Target private pools by tags. Valid values of N: 1 to 20. Note:

    • When this parameter is specified, the system filters only the associated Target private pools under the account that match the tags and satisfy the scaling group constraints (such as zone and instance type).

    • Tag matching rule: a private pool must match all specified tags.

    • This parameter cannot be specified together with the PrivatePoolIds parameter.

    Key

    string

    No

    The tag key of the private pool.

    TestKey
    Value

    string

    No

    The tag value of the private pool.

    TestValue
    InstanceTypeCandidateOptions

    object

    No

    After the alternative mode is enabled, when issues such as insufficient inventory occur, the system supplements similar instance types of the same size based on the currently selected instance types, or creates vSwitches in alternative zones and adds them to the scaling group.

    Enabled

    boolean

    No

    Specifies whether to enable the alternative mode.

    true
    MaxPrice

    number

    No

    The maximum price for alternative instance types.

    2.10
    AllowDifferentGeneration

    boolean

    No

    Specifies whether to allow supplementing instance types of other generations.

    • For example, if the current instance type is ecs.c7.large, enabling this option allows alternative instance types such as ecs.c6.large and ecs.c8.large.

    true
    AllowCrossAz

    boolean

    No

    Specifies whether to allow supplementing vSwitches in other zones.

    Note

    The instance type remains unchanged. Only new zones are used as alternatives. When all selected zones of the scaling group cannot be used for scale-out due to issues such as insufficient inventory, the system automatically adds a new vSwitch in a new zone to the scaling group based on this configuration. For example, if the scaling group is configured with the cn-hangzhou-h and cn-hangzhou-g zones, and neither zone can be used for scale-out, Auto Scaling may create a vSwitch in cn-hangzhou-k based on real-time inventory and add it to the scaling group.

    true
    AllowCidrBlocks

    array

    No

    The CIDR blocks for vSwitches that can be supplemented in other zones.

    string

    No

    The vSwitch CIDR block must meet the following requirements:

    • The mask length of the vSwitch CIDR block must be 16 to 29 bits.

    • The vSwitch CIDR block must be a subset of the CIDR block of the VPC to which the vSwitch belongs.

    • The vSwitch CIDR block cannot be the same as the destination CIDR block of a route entry in the VPC, but can be a subset of the destination CIDR block.

    • The vSwitch CIDR block cannot be 100.64.0.0/10 or its subnets.

    172.16.0.0/24

    Response elements

    Element

    Type

    Description

    Example

    object

    The information about the created scaling configuration.

    ScalingConfigurationId

    string

    The ID of the scaling configuration.

    asc-bp1ffogfdauy0nu5****
    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    Examples

    Success response

    JSON format

    {
  "ScalingConfigurationId": "asc-bp1ffogfdauy0nu5****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.