ModifyScalingConfiguration

更新时间:
复制 MD 格式

If a scaling configuration does not meet your business needs, you can call the ModifyScalingConfiguration operation to modify the scaling configuration. A scaling configuration is a template for creating ECS instances during scale-out events.

Operation description

  • Scaling configurations in the same scaling group cannot have the same name.

  • You can configure the primary elastic network interface (ENI) in one of the following ways. You can use only one method in a single API call. If you use both methods, the call fails and an error message is returned. When you modify the ENI configuration, using one method clears any configuration set by the other method.

    • Directly set the configuration of the primary ENI using parameters such as `SecurityGroupId`, `SecurityGroupIds`, and `Ipv6AddressCount`.

    • Set the configuration of the primary and secondary ENIs using the `NetworkInterfaces` parameter. When you use this parameter, you must configure the primary ENI. To specify the primary ENI, set `NetworkInterface.InstanceType` to `Primary`. To specify a secondary ENI, set `NetworkInterface.InstanceType` to `Secondary` or leave the parameter empty.

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 I/O optimized. Valid values:

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

  • optimized: The instance is I/O optimized.

none

SpotStrategy

string

No

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

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

  • SpotWithPriceLimit: a spot instance for which you specify the maximum hourly price.

  • SpotAsPriceGo: a spot instance for which the system automatically bids based on the current market price.

NoSpot

ScalingConfigurationName

string

No

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

The name of a 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 instances that are automatically created using this scaling configuration.

inst****

HostName

string

No

The hostname of the ECS instance. A period (.) or a hyphen (-) cannot be used as the first or last character of the hostname. Consecutive periods (.) or hyphens (-) are not allowed. The naming conventions for hostnames vary based on the instance operating system:

  • For 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 of only digits.

  • For other instance types, such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

hos****

ImageId

string

No

The ID of the image file that is used to create the instances.

Note

If the image that was previously used in the scaling configuration includes a system disk and data disks, the original data disk information is cleared after you change the image.

centos6u5_64_20G_aliaegis_2014****.vhd

ImageName

string

No

The name of the image file. The image name must be unique in a region. If you specify `ImageId`, `ImageName` is ignored.

You cannot use `ImageName` to specify a Marketplace image.

suse11sp3_64_20G_aliaegis_2015****.vhd

Cpu

integer

No

The number of vCPUs. Unit: cores.

You can specify both `Cpu` and `Memory` to define a range of instance types. For example, if you set `Cpu` to 2 and `Memory` to 16, all instance types with 2 vCPUs and 16 GiB of memory are matched. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone, and then creates the instance of the lowest-priced instance type.

Note

This configuration is effective only when the cost optimization mode is enabled and no instance types are specified in the scaling configuration.

2

Memory

integer

No

The memory size. Unit: GiB.

You can specify both `Cpu` and `Memory` to define a range of instance types. For example, if you set `Cpu` to 2 and `Memory` to 16, all instance types with 2 vCPUs and 16 GiB of memory are matched. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone, and then creates the instance of the lowest-priced instance type.

Note

This configuration is effective only when the cost optimization mode is enabled and no instance types are specified in the scaling configuration.

16

InternetChargeType

string

No

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth. If you set the value to PayByBandwidth, the value of `InternetMaxBandwidthOut` is the selected fixed bandwidth.

  • PayByTraffic: pay-by-data-transfer. If you set the value to PayByTraffic, the value of `InternetMaxBandwidthOut` is the maximum bandwidth, and the 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 disk. Valid values:

  • cloud: basic disk.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

  • ephemeral_ssd: local SSD.

You cannot specify this parameter and SystemDiskCategories at the same time. If neither this parameter nor SystemDiskCategories is specified, this parameter has a default value. If the instance type is from instance family I and the instance is not I/O optimized, the default value is `cloud`. Otherwise, the default value is `cloud_efficiency`.

cloud_efficiency

SystemDisk.Size

integer

No

The size of the system disk. Unit: GiB. Value range:

  • Basic disks: 20 to 500.

  • ESSDs:
    • PL0: 1 to 2048.

    • PL1: 20 to 2048.

    • PL2: 461 to 2048.

    • PL3: 1261 to 2048.

  • ESSD AutoPL cloud disks: 1 to 2048.

  • Other disk categories: 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 disk. The name must be 2 to 128 English or Chinese characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. It can contain digits, colons (:), underscores (_), and hyphens (-). Default value: empty

cloud_ssdSystem

SystemDisk.Description

string

No

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

Test system disk.

SystemDisk.AutoSnapshotPolicyId

string

No

The ID of the automatic snapshot policy used for the system disk.

sp-bp12m37ccmxvbmi5****

SystemDisk.PerformanceLevel

string

No

The performance level of the ESSD that is used as the system disk. 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 more information about how to select an ESSD performance level, see ESSDs.

PL0

LoadBalancerWeight

integer

No

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

50

UserData

string

No

The custom data of the ECS instance. The data must be Base64-encoded. The raw data can be up to 32 KB in size.

ZWNobyBoZWxsbyBlY3Mh

KeyPairName

string

No

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

  • For Windows instances, this parameter is ignored. The default value is empty.

  • For Linux instances, password-based logon is disabled by default.

KeyPair_Name

RamRoleName

string

No

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

RamRoleTest

PasswordInherit

boolean

No

Specifies whether to use the password that is preset in the image. If you use this parameter, make sure that a password is set for the image.

false

Tags

string

No

The tags of the ECS instance. You can specify up to 20 tags in key-value pairs. The following limits apply to keys and values:

  • A key can be up to 64 characters in length, cannot start with aliyun or acs:, and cannot contain http:// or https://. If you specify tags, the key cannot be an empty string.

  • A value can be up to 128 characters in length, cannot start with aliyun or acs:, and cannot contain http:// or https://. The 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 overwrite the parameter. Valid values:

  • true: Overwrite the parameter.

  • false: Do not overwrite the parameter.

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 English or Chinese characters in length and cannot start with http:// or https://.

Test instance.

Ipv6AddressCount

integer

No

The number of randomly generated IPv6 addresses to be assigned to the ENI.

1

CreditSpecification

string

No

The performance mode of the burstable instance. Valid values:

  • Standard: the standard mode. For more information about the instance performance, see the "Performance modes" section in What is a burstable instance?.

  • Unlimited: the unlimited mode. For more information about the instance performance, see the "Performance modes" section in What is a burstable instance?.

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 to create instances. If you have set the ImageId parameter, you cannot set this parameter.

hangzhou-daily-update

ZoneId

string

No

The ID of the zone to which the ECS instance belongs.

cn-hangzhou-g

DedicatedHostId

string

No

Specifies whether to create the ECS instance on a dedicated host. If you specify `DedicatedHostId`, the `SpotStrategy` and `SpotPriceLimit` settings in the request are ignored. This is because dedicated hosts do not support spot instances.

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

dh-bp67acfmxazb4p****

Affinity

string

No

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

  • default: The instance is not associated with the dedicated host. If you restart an instance that was stopped in economical mode, the instance may be placed on a different dedicated host in the automatic deployment resource pool if the resources of the original dedicated host are insufficient.

  • host: The instance is associated with the dedicated host. If you restart an instance that was stopped in economical mode, the instance is still placed on the original dedicated host. If the resources of the original dedicated host are insufficient, the instance fails to restart.

default

Tenancy

string

No

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

  • default: Create the instance not on a dedicated host.

  • host: Create the 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 scheduling options.

["testManagedPrivateSpaceId****"]

PrivatePoolOptions.MatchCriteria

string

No

The capacity option of the private pool for starting the instance. The private pool is generated after an Elastic Assurance service or a Capacity Reservation service takes effect. You can select a private pool to start an instance. Valid values:

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

  • Target: specified mode. The instance is started using the capacity of a specified private pool. If the specified private pool is unavailable, the instance fails to start. You must specify the private pool ID by setting the `PrivatePoolOptions.Id` parameter in this mode.

  • None: no mode. The instance is not started using the capacity of a private pool.

Open

PrivatePoolOptions.Id

string

No

The ID of the private pool. The private pool can be an Elastic Assurance service or a Capacity Reservation service.

eap-bp67acfmxazb4****

SpotDuration

integer

No

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

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

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

Note

Alibaba Cloud sends a notification to you through ECS system events 5 minutes before the instance is released. Spot instances are billed by the second. Select a protection period based on the time required to complete your task.

Default value: 1.

1

SpotInterruptionBehavior

string

No

The interruption mode of the spot instance. Currently, only Terminate is supported, which is the default value. This value indicates that the instance is directly released.

Terminate

DataDisks

array<object>

No

The collection of data disk information.

object

No

The collection of data disk information.

PerformanceLevel

string

No

The performance level of the ESSD that is used as the data disk. 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 more information about how to select an ESSD performance level, see ESSDs.

PL1

AutoSnapshotPolicyId

string

No

The ID of the automatic snapshot policy used for the data disk.

sp-bp19nq9enxqkomib****

Encrypted

string

No

Specifies whether the system disk is encrypted. Valid values:

  • true: The system disk is encrypted.

  • false: The system disk is not encrypted.

false

Description

string

No

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

Test data disk.

SnapshotId

string

No

The snapshot that is used to create the data disk. If you specify this parameter, `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 call is rejected, and the `InvalidSnapshot.TooOld` error is returned.

s-snapshot****

Categories

array

No

The categories of the data disk. Valid values:

  • cloud: basic disk. The `DeleteWithInstance` attribute of a basic disk that is created with an instance is `true`.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

Note

You cannot specify this parameter and DataDisk.Category at the same time.

string

No

The categories of the data disk. If a disk of a category with a higher priority cannot be created, Auto Scaling automatically tries to create a disk of a category with the next priority. Valid values:

  • cloud: basic disk. The `DeleteWithInstance` attribute of a basic disk that is created with an instance is `true`.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

Note

You cannot specify this parameter and DataDisk.Category at the same time.

cloud

Size

integer

No

The size of the data disk. Unit: GiB. Value range:

  • cloud: 5 to 2000.

  • cloud_efficiency: 20 to 32768.

  • cloud_ssd: 20 to 32768.

  • cloud_essd: 20 to 32768.

  • ephemeral_ssd: 5 to 800.

If 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 disk. If you do not specify this parameter, the system allocates a mount point when the ECS instance is automatically created. The mount point starts from /dev/xvdb and goes to /dev/xvdz.

/dev/xvdd

DiskName

string

No

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

cloud_ssdData

Category

string

No

The category of the data disk. Valid values:

  • cloud: basic disk. The `DeleteWithInstance` attribute of a basic disk that is created with an instance is `true`.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • ephemeral_ssd: local SSD.

  • cloud_essd: ESSD.

You cannot specify this parameter and DataDisk.Categories at the same time. If neither this parameter nor DataDisk.Categories is specified, this parameter has a default value:

  • 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 disk when the instance is released. Valid values:

  • true: The disk is released with the instance.

  • false: The disk is not released with the instance.

You can set this parameter only for independent cloud disks (`DataDisk.Category` is `cloud`, `cloud_efficiency`, `cloud_ssd`, `cloud_essd`, or `cloud_auto`). Otherwise, an error occurs.

true

KMSKeyId

string

No

The ID of the KMS key for the data disk.

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

ProvisionedIops

integer

No

The pre-configured IOPS of the data disk.

Note

IOPS, or input/output operations per second, is the number of I/O operations that a block storage device can process per second. It indicates the read and write performance of the block storage device.

100

BurstingEnabled

boolean

No

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

  • true: Enabled.

  • false: Disabled.

Note

This parameter takes effect only when SystemDisk.Category is set to cloud_auto.

For more information, see ESSD AutoPL cloud disks.

false

SpotPriceLimits

array<object>

No

The information about the spot instance types.

object

No

The information about the spot instance types.

PriceLimit

number

No

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

0.125

InstanceType

string

No

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

ecs.g6.large

InstanceTypes

array

No

The instance types. If you use `InstanceTypes`, `InstanceType` is ignored.

If an instance cannot be created using the instance type with a higher priority, Auto Scaling automatically uses the instance type with the next priority to create the instance.

string

No

The instance types. If you use `InstanceTypes`, `InstanceType` is ignored.

If an instance cannot be created using the instance type with a higher priority, Auto Scaling automatically uses the instance type with the next priority 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 to specify the capacity of an instance type in a scaling configuration, specify this parameter and `InstanceTypeOverride.WeightedCapacity`.

This parameter is used to specify an instance type. You can specify this parameter multiple times. You can use this parameter with the `InstanceTypeOverride.WeightedCapacity` parameter to enable custom weights for multiple instance types.

Note

If you specify this parameter, you cannot specify `instanceTypes`.

Valid values of InstanceType: available ECS instance types.

ecs.c5.xlarge

WeightedCapacity

integer

No

If you want the scaling group to scale based on the capacity of instance types, specify this parameter after you specify `LaunchTemplateOverride.InstanceType`.

This parameter specifies the weight of an instance type, which indicates the capacity of a single instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity.

You can set different weights for different instance types as needed because the performance metrics, such as the number of vCPUs and memory size, vary based on the instance type.

For example:

  • Current capacity: 0.

  • Expected capacity: 6.

  • Capacity of the ecs.c5.xlarge instance type: 4.

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

Note

The capacity of the scaling group after a scale-out activity cannot exceed the sum of the maximum capacity (MaxSize) and the maximum weight of an instance type.

Valid values of WeightedCapacity: 1 to 500.

4

SecurityGroupIds

array

No

The ID of the security group.

string

No

The IDs of the security groups.

sg-bp18kz60mefs****

InstancePatternInfos

array<object>

No

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

object

No

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

Cores

integer

No

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

Note the following information:

  • The `InstancePatternInfo` parameter is applicable only to scaling groups whose NetworkType is set to VPC.

  • You must specify `InstancePatternInfo.Cores` and `InstancePatternInfo.Memory` at the same time.

  • If you specify instance types using the `InstanceType` or `InstanceTypes` parameter, Auto Scaling preferentially uses the specified instance types for scale-out activities. If the specified instance types are out of stock, Auto Scaling uses the lowest-priced instance type among those that meet the requirements specified by the `InstancePatternInfo` parameter for scale-out activities.

2

InstanceFamilyLevel

string

No

The level of the instance family. This parameter is used to filter instance types. This parameter takes effect only when `CostOptimization` is enabled. Valid values:

  • EntryLevel: entry-level instances (shared). This instance type is cost-effective but does not provide stable computing performance. It is suitable for business scenarios that have low CPU utilization. For more information, see Shared instance families.

  • EnterpriseLevel: enterprise-level instances. This instance type provides stable performance and dedicated resources, and is suitable for business scenarios that have high stability requirements. For more information, see Instance families.

  • CreditEntryLevel: credit entry-level instances (burstable). This instance type provides CPU credits to ensure computing performance. It is suitable for business scenarios that have low and sporadic CPU utilization. For more information, see Overview of burstable instances.

EnterpriseLevel

MaxPrice

number

No

The maximum hourly price that you can accept for a pay-as-you-go or spot instance in intelligent configuration mode. This parameter is used to filter instance types.

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.

4

Architectures

array

No

The architecture type of the instance type. Valid values:

  • X86: x86.

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

  • BareMental: ECS Bare Metal Instance.

  • Arm: Arm.

Default value: all architecture types.

string

No

The architecture type of the instance type. Valid values:

  • X86: x86.

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

  • BareMental: ECS Bare Metal Instance.

  • Arm: Arm.

Default value: all architecture types.

X86

BurstablePerformance

string

No

Specifies whether to include burstable instance types. Valid values:

  • Exclude: do not include burstable instance types.

  • Include: include burstable instance types.

  • Required: include only burstable instance types.

Default value: Include.

Include

ExcludedInstanceTypes

array

No

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

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

  • ecs.c6.*: excludes all instance types of the c6 family.

string

No

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

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

  • ecs.c6.*: excludes all instance types of the c6 family.

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

InstanceTypeFamilies

array

No

The instance families to query. You can specify up to 10 instance families.

string

No

The instance families to query. You can specify up to 10 instance families.

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

The value of `MaximumCpuCoreCount` cannot be more than four times the value of `MinimumCpuCoreCount`.

4

GpuSpecs

array

No

The GPU type.

string

No

The GPU type.

NVIDIA V100

InstanceCategories

array

No

The category 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 instance families.

  • Shared: shared-resource instances.

  • Compute-optimized with GPU: GPU.

  • Visual Compute-optimized: visual compute-optimized.

  • Heterogeneous Service: heterogeneous computing.

  • Compute-optimized with FPGA: FPGA.

  • Compute-optimized with NPU: NPU-accelerated.

  • ECS Bare Metal: ECS Bare Metal Instance.

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

string

No

The category 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 instance families.

  • Shared: shared-resource instances.

  • Compute-optimized with GPU: GPU.

  • Visual Compute-optimized: visual compute-optimized.

  • Heterogeneous Service: heterogeneous computing.

  • Compute-optimized with FPGA: FPGA.

  • Compute-optimized with NPU: NPU-accelerated.

  • ECS Bare Metal: ECS Bare Metal Instance.

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

Compute-optimized with GPU

CpuArchitectures

array

No

The CPU architecture of the instance. Valid values:

Note

You can specify up to two CPU architectures.

  • X86.

  • ARM.

string

No

The CPU architecture of the instance type. Valid values:

Note

You can specify up to two CPU architectures.

  • X86.

  • ARM.

X86

PhysicalProcessorModels

array

No

The processor model of the instance. You can specify up to 10 processor models.

string

No

The processor model of the instance. You can specify up to 10 processor models.

Intel Xeon(Ice Lake) Platinum 8369B

MinimumEniQuantity

integer

No

The minimum number of ENIs that can be attached to the instance.

2

MinimumEniPrivateIpAddressQuantity

integer

No

The minimum number of IPv4 addresses that can be assigned to a single ENI of the instance.

2

MinimumEniIpv6AddressQuantity

integer

No

The minimum number of IPv6 addresses that can be assigned to a single ENI of the instance.

1

MinimumInitialCredit

integer

No

The minimum initial vCPU credit for a t5 or t6 burstable instance.

12

MinimumBaselineCredit

integer

No

The minimum baseline vCPU computing performance (for all vCPUs) of a t5 or t6 burstable instance.

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 categories of the system disk. If a disk of a category with a higher priority cannot be created, Auto Scaling automatically tries to create a disk of a category with the next priority. Valid values:

  • cloud: basic disk.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

Note

You cannot specify this parameter and SystemDisk.Category at the same time.

string

No

The categories of the system disk. If a disk of a category with a higher priority cannot be created, Auto Scaling automatically tries to create a disk of a category with the next priority. Valid values:

  • cloud: basic disk.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

Note

You cannot specify this parameter and 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 contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters can be:

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

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

Note

If you specify the `Password` parameter, we recommend that you send requests over HTTPS to prevent password leaks.

123abc****

SystemDisk.Encrypted

boolean

No

Specifies whether to encrypt the system disk. Valid values:

  • true: encrypt the system disk.

  • false: do not encrypt the system disk.

Default value: false.

false

SystemDisk.KMSKeyId

string

No

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

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

SystemDisk.EncryptAlgorithm

string

No

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

  • AES-256.

  • SM4-128.

Default value: AES-256.

AES-256

SystemDisk.ProvisionedIops

integer

No

The pre-configured IOPS of the system disk.

Note

IOPS, or input/output operations per second, is the number of I/O operations that a block storage device can process per second. It indicates the read and write performance of the block storage device.

100

SystemDisk.BurstingEnabled

boolean

No

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

  • true: enable.

  • false: disable.

Note

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

For more information, see ESSD AutoPL cloud disks.

false

ImageOptions.LoginAsNonRoot

boolean

No

Specifies whether to log on to the ECS instance as the ecs-user user. For more information, see Manage logon usernames of ECS instances. Valid values:

true: yes.

false: no.

false

DeletionProtection

boolean

No

The release protection attribute of the instance. This parameter specifies whether you can release the instance using the ECS console or by calling the DeleteInstance operation. This prevents the instance from being accidentally released. Valid values:

  • true: enables release protection. You cannot release the instance using the ECS console or by calling the DeleteInstance operation.

  • false: disables release protection. You can release the instance using the ECS console or by calling the DeleteInstance operation.

Note

This attribute applies only to pay-as-you-go instances. It prevents the instances that are scaled out by Auto Scaling from being accidentally released. This attribute does not affect normal scale-in activities. Instances for which release protection is enabled can be released during scale-in activities.

false

StorageSetId

string

No

The ID of the storage set.

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 priority of the ECS instance type and vSwitch.

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

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

Note

If you specify custom priorities for only some instance type and vSwitch combinations, the combinations for which you do not specify custom priorities have a lower priority than the combinations for which you specify custom priorities. The priority of the combinations for which you do not specify custom priorities is determined by the order of vSwitches in the scaling group and the order of instance types in the scaling configuration.

  • For example, if the vSwitches in the scaling group are ordered as vsw1 and vsw2, the instance types in the scaling configuration are ordered as type1 and type2, and the custom priority is set to ["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 list of instance types in the scaling configuration.

ecs.c6a.4xlarge

VswitchId

string

No

The ID of the vSwitch.

Note

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

vsw-bp14zolna43z266bq****

NetworkInterfaces

array<object>

No

The list of ENIs.

object

No

The ENI.

InstanceType

string

No

The type of the ENI. When you use this parameter, you must use `NetworkInterfaces` to configure the primary ENI. You cannot set the `SecurityGroupId` or `SecurityGroupIds` parameter. Valid values:

  • Primary: primary ENI.

  • Secondary: secondary ENI.

Default value: Secondary.

Primary

NetworkInterfaceTrafficMode

string

No

The communication mode of the 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 ENIs in RDMA mode cannot exceed the limit for the instance family. For more information, see Instance families.

HighPerformance

Ipv6AddressCount

integer

No

The number of randomly generated IPv6 addresses to be assigned to the primary ENI. Note:

This parameter takes effect only when `NetworkInterface.InstanceType` is set to `Primary`. You cannot set this parameter if `NetworkInterface.InstanceType` is set to `Secondary` or is empty.

After you set this parameter, you cannot set `Ipv6AddressCount`.

1

SecurityGroupIds

array

No

The IDs of one or more security groups to which the ENI belongs.

string

No

The IDs of one or more security groups to which the 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`. However, you cannot set `SecurityGroupId` or `SecurityGroupIds`.

  • If `NetworkInterface.InstanceType` is set to `Secondary` or is empty, this parameter is optional. The default value is the security group of the ECS instance, which is the security group of the primary ENI.

sg-2ze55shrxxxxx

SecondaryPrivateIpAddressCount

integer

No

The number of secondary private IPv4 addresses to assign to the NIC. 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` is used to assign a number of secondary private IPv4 addresses to the NIC, excluding the primary private IP address of the NIC. The system randomly assigns the addresses from the available CIDR block of the vSwitch where the NIC is located (`NetworkInterface.N.VSwitchId`).

6

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

  • disabled: disable.

Default value: enabled.

Note

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

enabled

HttpTokens

string

No

Specifies whether to enforce the security-hardened mode (IMDSv2) when you access instance metadata. Valid values:

  • optional: does not enforce the use of IMDSv2.

  • required: enforces the use of IMDSv2. If you set the value to `required`, you cannot access instance metadata in normal mode.

Default value: optional.

Note

For more information about how to access instance metadata, see Access modes of instance metadata.

optional

InternetMaxBandwidthIn

integer

No

The maximum inbound public bandwidth. Unit: Mbit/s. Value range:

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

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

10

ResourcePoolOptions

object

No

The resource pool policy to use when creating an instance. Note the following when you set this parameter:

  • This parameter is in effect only when you create a pay-as-you-go instance.

  • You cannot set this parameter and `PrivatePoolOptions.MatchCriteria` or `PrivatePoolOptions.Id` at the same time.

Strategy

string

No

The resource pool includes the private pool generated after an Elastic Assurance service or a Capacity Reservation service takes effect, and the public pool. You can select a resource pool to start an instance. Valid values:

  • PrivatePoolFirst: The private pool is used first. If you select this policy and specify `ResourcePoolOptions.PrivatePoolIds` or meet the `PrivatePoolTags` conditions, the corresponding private pool is used first. If you do not specify a private pool or the specified private pool has insufficient capacity, the system automatically matches an open private pool. If no eligible private pools are available, a public pool is used to create the instance.

  • PrivatePoolOnly: Only the private pool is used. If you select this policy, you must specify `ResourcePoolOptions.PrivatePoolIds`. If the specified private pool has insufficient capacity, the instance fails to start.

  • PublicPoolFirst: The public pool is used first. A public pool is used first to create the instance. If the public pool has insufficient resources, a private pool is used. The system preferentially matches an open private pool. If no eligible private pools are available, the system uses the Target private pool that is specified by `ResourcePoolOptions.PrivatePoolIds` or meets the `PrivatePoolTags` conditions. (This policy is in invitational preview and is not yet available for use.)

  • None: No resource pool policy is used.

Default value: None.

PrivatePoolFirst

PrivatePoolIds

array

No

The ID of the private pool. The private pool can be an Elastic Assurance service or a Capacity Reservation service. You can only specify the ID of a Target private pool. You cannot specify this parameter and the `PrivatePoolTags` parameter at the same time.

string

No

The ID of the private pool. The private pool can be an Elastic Assurance service or a Capacity Reservation service. You can only specify the ID of a Target private pool. You cannot specify this parameter and the `PrivatePoolTags` parameter at the same time. You can specify up to 20 private pool IDs.

eap-bp67acfmxazb4****

PrivatePoolTags

array<object>

No

Filter available Target private pools by tag. You can specify up to 20 tags. Description:

  • When you configure this parameter, the system filters only the associated Target private pools under your account to find private pools that match the tags and meet the constraints of the scaling group, such as zone and instance type.

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

  • You cannot specify this parameter and the `PrivatePoolIds` parameter at the same time.

object

No

Filter available Target private pools by tag. You can specify up to 20 tags. Description:

  • When you configure this parameter, the system filters only the associated Target private pools under your account to find private pools that match the tags and meet the constraints of the scaling group, such as zone and instance type.

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

  • You cannot specify this parameter and the `PrivatePoolIds` parameter at the same time.

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 you enable the alternative mode, if issues such as insufficient inventory occur, the system supplements the selected instance types with similar instance types of the same size, 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.

1.5

AllowDifferentGeneration

boolean

No

Specifies whether to allow supplementing with instance types from other generations.

  • For example, if the current instance type is ecs.c7.large, you can enable this feature to use alternative instance types such as ecs.c6.large and ecs.c8.large.

true

AllowCrossAz

boolean

No

Specifies whether to allow supplementing with vSwitches from other zones.

Note

The instance type remains unchanged, and only new zones are selected as alternatives. When the scaling group cannot be scaled out in any of the selected zones due to issues such as insufficient inventory, the system automatically adds a new vSwitch in another zone to the scaling group based on this configuration. For example, if the scaling group is configured with zones cn-hangzhou-h and cn-hangzhou-g, and scale-out fails in both zones, ESS may create a vSwitch in cn-hangzhou-k and add it to the scaling group based on real-time inventory.

true

AllowCidrBlocks

array

No

When supplementing with vSwitches from other zones is allowed, you must specify the optional CIDR blocks for the vSwitches.

string

No

When supplementing with vSwitches from other zones is allowed, you must specify the optional CIDR blocks for the vSwitches.

172.16.0.0/24

Response elements

Element

Type

Description

Example

object

The information 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.