All Products
Search
Document Center

Auto Scaling:ModifyScalingConfiguration

Last Updated:Jul 16, 2026

Modifies an ECS-type scaling configuration (the ECS instance template for scale-out) if the current scaling configuration does not meet your business requirements.

Operation description

  • If you modify the name of a scaling configuration, ensure that no other scaling configuration in the same scaling group has the same name.

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

    • Directly configure the primary NIC by using parameters such as SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount.

    • Configure the primary NIC and secondary NICs by using the NetworkInterfaces parameter. When you use the NetworkInterfaces 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.

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:ModifyScalingConfiguration

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None None

Request parameters

Parameter

Type

Required

Description

Example

ScalingConfigurationId

string

Yes

The ID of the scaling configuration that you want to modify.

asc-bp16har3jpj6fjbx****

IoOptimized

string

No

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

  • none: The instance is not an I/O optimized instance.

  • optimized: The instance is an I/O optimization instance.

none

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 for which the market price at the time of purchase is automatically used as the bid price.

NoSpot

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 (.). It must start with a letter, digit, or Chinese character.

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

test-modify

InstanceName

string

No

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

inst****

HostName

string

No

The hostname of the Elastic Compute Service (ECS) server. A period (.) or a hyphen (-) cannot be used as the first or last character, or used consecutively. In addition, the naming conventions for different types of instances are as follows:

  • Windows instances: The hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). It cannot contain periods (.) or consist 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 (-).

hos****

ImageId

string

No

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

Note

If the image previously used in the scaling configuration includes a system cloud disk and data cloud disks, the data cloud disk information is purged after you change the image.

centos6u5_64_20G_aliaegis_2014****.vhd

ImageName

string

No

The name of the image. Image names must be unique within a region. If you specify ImageId, ImageName is ignored.

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

suse11sp3_64_20G_aliaegis_2015****.vhd

Cpu

integer

No

The number of vCPUs. Unit: cores.

You can specify both CPU and Memory to define 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 active instance types based on factors such as I/O optimization and zones, and then creates instances of the lowest-priced instance type based on sorting by price.

Note

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

2

Memory

integer

No

The memory size. Unit: GiB.

You can specify both CPU and Memory to define 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 active instance types based on factors such as I/O optimization and zones, and then creates instances of the lowest-priced instance type based on sorting by price.

Note

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

16

InternetChargeType

string

No

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth. In this case, the value of InternetMaxBandwidthOut specifies the fixed bandwidth value.

  • PayByTraffic: pay-by-traffic. In this case, the value of InternetMaxBandwidthOut specifies only the maximum bandwidth, and billing is based on the actual network traffic.

PayByBandwidth

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.

  • cloud_essd: Enterprise SSD (ESSD).

  • ephemeral_ssd: local SSD.

This parameter cannot be specified together with SystemDiskCategories. If neither this parameter nor SystemDiskCategories is specified, a default value is used. If the instance type belongs to Generation I instance families and the instance is not an I/O optimization instance, the default value is cloud. Otherwise, the default value is cloud_efficiency.

cloud_efficiency

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: 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}.

50

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 (-). It must start with a letter or Chinese character and cannot start with http:// or https://. Default value: empty.

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 ESSD can deliver up to 10,000 random read/write IOPS.

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

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

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

Note

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

PL0

LoadBalancerWeight

integer

No

The weight of SLB backend server. Valid values: 1 to 100.

50

UserData

string

No

The user data of the ECS instance. The data must be encoded in Base64. 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.

KeyPair_Name

RamRoleName

string

No

The name of the RAM role associated with the ECS instance. This name is provided and maintained by RAM. You can call the ListRoles operation to query available RAM roles. For more information about how to create a RAM role, see the CreateRole operation.

RamRoleTest

PasswordInherit

boolean

No

Specifies whether to use the password preset in the image. To use this parameter, ensure that a password is configured for the image.

false

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:. It cannot 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:. It cannot contain http:// or https://. Value can be an empty string.

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

DeploymentSetId

string

No

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

ds-bp13v7bjnj9gis****

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-F876F****

Override

boolean

No

Specifies whether to override existing data. Valid values:

  • true: overrides existing data.

  • false: does not override existing data.

true

ResourceGroupId

string

No

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

abcd1234abcd****

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.

Ipv6AddressCount

integer

No

The number of randomly generated IPv6 addresses allocated to the elastic network interfaces (ENIs).

1

CreditSpecification

string

No

Modifies the running mode of a burstable instance. Valid values:

Standard

ImageFamily

string

No

The name of the image family. You can set this parameter to obtain the latest available image from the specified image family for instance creation. If you have specified the ImageId parameter, you cannot specify 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, if you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored.

You can call the DescribeDedicatedHosts operation 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 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 resources, the instance fails to restart.

default

Tenancy

string

No

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

  • default: creates an instance that is not on a dedicated host.

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

default

SchedulerOptions

object

No

The scheduler options.

["testManagedPrivateSpaceId****"]

PrivatePoolOptions.MatchCriteria

string

No

The private pool option for instance startup. A private pool is generated after an elasticity assurance or capacity reservation takes effect. You can select a private pool when you start an instance. Valid values:

  • Open: open mode. The system automatically matches an open private pool. If no matching private pool is available, the public pool is used to start the instance. You do not need to specify PrivatePoolOptions.Id 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 PrivatePoolOptions.Id is required.

  • None: no private pool is used. The instance does not use any private pool capacity for 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 a spot instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After 1 hour, the system compares the bid price with the market price and checks resource availability to determine whether to retain automatic release the instance.

  • 0: After a spot instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the bid price with the market price and checks resource availability 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. Currently, only Terminate (default) is supported, which directly releases the instance.

Terminate

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 of the data cloud disk when the disk is an ESSD. Valid values:

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

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

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

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

Note

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

PL1

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.

false

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 data disk.

SnapshotId

string

No

The ID of the snapshot used to create the data cloud disk. After this parameter is specified, DataDisk.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 request is rejected and the error message InvalidSnapshot.TooOld is returned.

s-snapshot****

Categories

array

No

The multiple disk types of the data cloud disk. Valid values:

  • cloud: basic cloud disk. The DeleteWithInstance property of a basic cloud disk created along 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_regional_disk_auto: regional ESSD.

Note

You cannot specify this parameter together with DataDisk.Category.

string

No

The multiple disk types of the data cloud disk. When a 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 along 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_regional_disk_auto: regional ESSD.

Note

You cannot specify this parameter together with DataDisk.Category.

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_ssd: 20 to 32768.

  • cloud_essd: 20 to 32768.

  • ephemeral_ssd: 5 to 800.

After you specify this parameter, the disk size must be greater than or equal to the size of the snapshot specified by SnapshotId.

100

Device

string

No

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

/dev/xvdd

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 (-). It must start with a letter or 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 attribute of a basic cloud disk created along 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_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 the data cloud disk is released when the instance is released. Valid values:

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

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

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

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 metrics of the data cloud disk.

Note

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

100

BurstingEnabled

boolean

No

Specifies whether to enable the burst feature for the data cloud disk. Valid values:

  • true: enables the burst feature.

  • false: does not enable the burst feature.

Note

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

false

SpotPriceLimits

array<object>

No

The information about spot instance types.

object

No

The information about spot instance types.

PriceLimit

number

No

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

0.125

InstanceType

string

No

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

ecs.g6.large

InstanceTypes

array

No

The instance types for multiple instance type support. If InstanceTypes is specified, InstanceType is ignored.

When instances cannot be created by using the instance type with a higher priority, Auto Scaling automatically selects the instance type with the next priority to create instances.

string

No

The instance types for multiple instance type support. If InstanceTypes is specified, InstanceType is ignored.

When instances cannot be created by using the instance type with a higher priority, Auto Scaling automatically selects the instance type with the next priority to create instances.

ecs.g6.large

InstanceTypeOverrides

array<object>

No

The information about specified instance types.

object

No

The information about specified instance types.

InstanceType

string

No

To specify the capacity of an instance type in the scaling configuration, specify both this parameter and InstanceTypeOverride.WeightedCapacity.

This parameter specifies the instance type. You can specify multiple instance types and use the InstanceTypeOverride.WeightedCapacity parameter to extend multi-instance-type support with custom weights.

Note

You cannot specify this parameter together with instanceTypes.

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

ecs.c5.xlarge

WeightedCapacity

integer

No

To scale the scaling group based on instance type capacity, specify this parameter after specifying LaunchTemplateOverride.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 vCPUs, memory, and other performance metrics, you can assign different weights to 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

SecurityGroupIds

array

No

The IDs of the security groups to which the instance belongs.

string

No

The IDs of the security groups to which the instance belongs.

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 InstancePatternInfo parameter applies only to scaling groups whose network type is VPC.

  • You must specify both InstancePatternInfo.Cores and InstancePatternInfo.Memory.

  • If you have specified instance types by using the InstanceType or InstanceTypes parameter, Auto Scaling preferentially uses the specified instance types for scale-out. When the specified instance types are out of stock, Auto Scaling selects the lowest-priced instance type from those that match the InstancePatternInfo parameter values.

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. They are suitable for scenarios that require high stability. For more information, see Instance families.

  • CreditEntryLevel: credit entry level, which refers to burstable instances. These instance types use CPU credits to ensure computing performance. They 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

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.

  • 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.

  • 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

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*

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.

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 types.

string

No

The GPU types.

NVIDIA V100

InstanceCategories

array

No

The categorization of the instance type. Valid values:

  • 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-accelerated compute-optimized.

  • Visual Compute-optimized: visual compute-optimized.

  • Heterogeneous Service: heterogeneous service.

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

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

  • ECS Bare Metal: ECS Bare Metal Instance.

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

string

No

The categorization of the instance type. Valid values:

  • 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-accelerated compute-optimized.

  • Visual Compute-optimized: visual compute-optimized.

  • Heterogeneous Service: heterogeneous service.

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

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

  • ECS Bare Metal: ECS Bare Metal Instance.

  • 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 architecture of the instance type. 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.

string

No

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

Intel Xeon(Ice Lake) Platinum 8369B

MinimumEniQuantity

integer

No

The minimum number of elastic network interfaces (ENIs) supported by the instance.

2

MinimumEniPrivateIpAddressQuantity

integer

No

The minimum number of IPv4 addresses per ENI supported by the instance. [_single.

2

MinimumEniIpv6AddressQuantity

integer

No

The minimum upper limit of IPv6 addresses on a single elastic network interfaces (ENIs) of the 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 (sum of all vCPUs) for burstable instances (t5 and t6).

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 multi-disk types for the system cloud disk. When a disk type with a higher priority is unavailable, Auto Scaling automatically attempts the next-priority disk type 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 multi-disk types for the system cloud disk. When a disk type with a higher priority is unavailable, Auto Scaling automatically attempts the next-priority disk type 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

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, we recommend that you send the request over HTTPS to prevent password leaks.

123abc****

SystemDisk.Encrypted

boolean

No

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

  • true: encrypts the system cloud disk.

  • false: does not encrypt the system cloud disk.

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 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) refers to the number of I/O operations that can be processed per second, representing the read/write (output/input) capability of block storage. Unit: operations per second.

100

SystemDisk.BurstingEnabled

boolean

No

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

  • true: enables the burst feature.

  • false: does not enable the burst feature.

Note

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

<props="china">For more information, see [ESSD AutoPL disks]( ESSD AutoPL cloud disks

false

ImageOptions.LoginAsNonRoot

boolean

No

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

  • true: The ecs-user account is used.

  • false: The ecs-user account is not used.

false

DeletionProtection

boolean

No

The release protection property of the instance. Specifies whether the instance can be directly released from the ECS console or by calling the DeleteInstance operation, to prevent accidental deletion. 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.

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 storage set ID.

ss-bp67acfmxazb4p****

StorageSetPartitionNumber

integer

No

The maximum number of partitions in the storage set. The value must be an integer that is greater than or equal to 2.

2

CustomPriorities

array<object>

No

The custom priorities for ECS instance type + vSwitch combinations.

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

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

Note

If you specify custom priorities for only some instance type + 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.

Note

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

ecs.c6a.4xlarge

VswitchId

string

No

The ID of the vSwitch.

Note

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 interfaces (ENIs).

InstanceType

string

No

The type of the elastic network interfaces (ENIs). When 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 network interface controller (NIC).

  • Secondary: secondary network interface controller (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 the following items:

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 interfaces (ENIs) belongs.

string

No

The IDs of one or more security groups to which the elastic network interfaces (ENIs) belongs. Note the following items:

  • If NetworkInterface.InstanceType is set to Primary, you must set this parameter. In this case, this parameter has the same effect as SecurityGroupIds. 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-2ze55shrxxxxx

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

VSwitchIds

array

No

The IDs of the vSwitches to which the elastic network interfaces (ENIs) belongs. N specifies that you can set multiple vSwitches. Valid values of N: 1 to 10.

Note the following items:

  • If InstanceType is set to Primary, you cannot set this parameter. The default value is the vSwitch of the instance.

  • If InstanceType is set to Secondary or left empty, this parameter is optional.

  • The system selects a vSwitch that is in the same zone as the primary network interface controller (NIC) and has the most available IP addresses.

string

No

The IDs of the vSwitches to which the elastic network interfaces (ENIs) belongs. N specifies that you can set multiple vSwitches. Valid values of N: 1 to 10.

Note the following items:

  • If InstanceType is set to Primary, you cannot set this parameter. The default value is the vSwitch of the instance.

  • If InstanceType is set to Secondary or left empty, this parameter is optional.

  • The system selects a vSwitch that is in the same zone as the primary network interface controller (NIC) and has the most available IP addresses.

vsw-bp67acfmxazb4p****

DedicatedHostClusterId

string

No

The ID of the dedicated host cluster.

dc-zm04u8r3lohsq****

SecurityOptions

object

No

The security options.

ConfidentialComputingMode

string

No

The confidential computing mode. 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) to access instance metadata. Valid values:

  • optional: does not forcefully use the security-hardened mode.

  • required: forcefully uses the security-hardened mode. After you set this value, instance metadata cannot be accessed in normal mode.

Default value: optional.

Note

For more information about the modes for accessing instance metadata, see Instance metadata access modes.

optional

InternetMaxBandwidthIn

integer

No

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

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

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

10

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

Resource pools include private pools generated after elasticity assurance or capacity reservation takes effect, and public pools, which are available for instance startup. Valid values:

  • PrivatePoolFirst: private pool first. When this strategy is selected, if ResourcePoolOptions.PrivatePoolIds is specified or PrivatePoolTags conditions are met, the corresponding private pools are 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 eligible private pool is available, the public pool is used to create instances.

  • PrivatePoolOnly: private pool only. When this strategy is selected, 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. When public pool resources are insufficient, private pool resources are used as a supplement. Open-type private pools are automatically matched first. If no eligible private pool is available, the Target-type private pools specified by ResourcePoolOptions.PrivatePoolIds or matching PrivatePoolTags conditions are used. (This strategy is in invitational preview and is not available for use.)

  • None: does not use a resource pool strategy.

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 for this parameter. 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 for this parameter. 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 Target private pools associated with 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 Target private pools associated with 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 fallback mode is enabled, when issues such as insufficient inventory are encountered, similar instance types of the same size are supplemented based on the currently selected instance types, or vSwitches in alternative zones are created and added to the scaling group.

Enabled

boolean

No

Specifies whether to enable the fallback mode.

true

MaxPrice

number

No

The maximum price for fallback instance types.

1.5

AllowDifferentGeneration

boolean

No

Specifies whether to allow supplementing instance types from other generations.

  • For example, if the current instance type is ecs.c7.large, enabling this option allows fallback to 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 alternative zones are selected. When all selected zones of the scaling group cannot be used for scale-out due to issues such as insufficient inventory, new zone vSwitches are automatically added 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 optional vSwitches when supplementing vSwitches in other zones.

string

No

The CIDR blocks for optional vSwitches when supplementing vSwitches in other zones.

172.16.0.0/24

SecondaryEniVSwitchConstraint

string

No

Specifies whether a vSwitch must be selected from the VSwitchIds list for the secondary elastic network interfaces (ENIs) when the VSwitchIds parameter is set for the secondary network interface controller (NIC).

  • Strict: strict mode. If no vSwitch in VSwitchIds meets the conditional requirements, instance creation fails.

  • Tolerant: tolerant mode. If no vSwitch in VSwitchIds meets the conditional requirements, no secondary network interface controller (NIC) is configured, but the instance is still created as active.

Default value: Strict.

Strict

Response elements

Element

Type

Description

Example

object

The response returned after the scaling configuration is modified.

RequestId

string

The request ID.

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

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.