Query scaling configurations - Auto Scaling - Alibaba Cloud - Auto Scaling

Queries information about ECS-type scaling configurations, including instance types and images, so that you can learn about the ECS instance templates used for elastic scale-out in advance.

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

get

*ScalingGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group to which the scaling configuration belongs.	cn-qingdao
PageNumber	integer	No	The page number of the scaling configuration list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	50
ScalingGroupId	string	No	The ID of the scaling group. You can query all scaling configurations in the specified scaling group.	asg-bp17pelvl720x3v7****
ScalingConfigurationIds	array	No	The ID of the scaling configuration that you want to query. The query results include scaling configurations in both the Active and Inactive states. The states are indicated by the LifecycleState response parameter.
	string	No	The ID of the scaling configuration that you want to query. The query results include scaling configurations in both the Active and Inactive states. The states are indicated by the LifecycleState response parameter.	asc-bp17pelvl720x5ub****
ScalingConfigurationNames	array	No	The name of the scaling configuration that you want to query. Invalid scaling configuration names are ignored in the query results, and no error is returned.
	string	No	The name of the scaling configuration that you want to query. Invalid scaling configuration names are ignored in the query results, and no error is returned.	scalingcon****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	50
TotalCount	integer	The total number of scaling configurations.	1
ScalingConfigurations	array<object>	The collection of scaling configuration information.
	array<object>	The collection of scaling configuration information.
DeploymentSetId	string	The ID of the deployment set to which the ECS instance belongs.	ds-bp1frxuzdg87zh4p****
CreationTime	string	The time when the scaling configuration was created.	2014-08-14T10:58Z
ScalingConfigurationName	string	The name of the scaling configuration.	scalingconfigura****
SystemDiskDescription	string	The description of the system cloud disk.	Test system disk.
KeyPairName	string	The name of the key pair used to log on to the ECS instance.	keypair****
SecurityGroupId	string	The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other.	sg-bp18kz60mefs****
PrivatePoolOptions.Id	string	The ID of the private pool. The ID of an elasticity assurance or a capacity reservation.	eap-bp67acfmxazb4****
SystemDiskAutoSnapshotPolicyId	string	The ID of the automatic snapshot policy applied to the system cloud disk.	sp-bp12m37ccmxvbmi5****
SpotStrategy	string	The preemption strategy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot instance with a user-defined maximum hourly price. SpotAsPriceGo: a spot instance priced at the market price at the time of purchase.	NoSpot
ScalingGroupId	string	The ID of the scaling group to which the scaling configuration belongs.	asg-bp17pelvl720x3v7****
Affinity	string	Indicates 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 resources of the original dedicated host are insufficient. 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 resources of the original dedicated host are insufficient, the instance fails to restart.	default
Tenancy	string	Indicates whether the instance is created on a dedicated host. Valid values: default: The instance is not created on a dedicated host. host: The instance is created on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud automatically selects a dedicated host for the instance. Default value: default.	default
SystemDiskSize	integer	The size of the system cloud disk. Unit: GiB.	100
Ipv6AddressCount	integer	The number of randomly generated IPv6 addresses allocated to the network interface controller (NIC).	1
SpotDuration	integer	The retention period of the spot instance. Unit: hours.	1
LifecycleState	string	The status of the scaling configuration in the scaling group. Valid values: Active: The scaling configuration is in the Active state. The scaling group uses the active scaling configuration for automatic creation of ECS instances. Inacitve: The scaling configuration is in the Inactive state. Inactive scaling configurations exist in the scaling group but are not used by the scaling group for automatic creation of ECS instances.	Active
InstanceName	string	The name of the ECS instance.	instance****
SecurityEnhancementStrategy	string	Indicates whether security hardening is enabled. Valid values: Active: Security hardening is enabled. This value is applicable only to public images. Deactive: Security hardening is disabled. This value is applicable to all image types.	Active
UserData	string	The user data of the ECS instance.	echo hello ecs!
PrivatePoolOptions.MatchCriteria	string	The private pool capacity option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for you to select 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 instance is started by using public pool resources. Target: specified mode. The instance is started by using the specified private pool. If the specified private pool is unavailable, the instance fails to start. None: none mode. The instance does not use private pool capacity.	Open
DedicatedHostId	string	Indicates whether the ECS instance is created on a dedicated host. Because dedicated hosts do not support the creation of spot instances, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored when DedicatedHostId is specified. You can call the DescribeDedicatedHosts operation to query the list of dedicated host IDs.	dh-bp67acfmxazb4p****
InstanceGeneration	string	The generation of the ECS instance.	ecs-3
HpcClusterId	string	The ID of the HPC cluster to which the ECS instance belongs.	hpc-clus****
PasswordInherit	boolean	Specifies whether to use the password preset in the image.	true
Memory	integer	The memory size. Unit: GiB. If you specify both CPU and Memory, you can define a range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, and then creates instances of the lowest-priced instance type. Note This configuration takes effect only when the cost optimization mode is enabled and no instance type is specified in the scaling configuration.	16
ImageId	string	The ID of the image file used for automatic creation of instances.	centos6u5_64_20G_aliaegis_2014****.vhd
ImageFamily	string	The name of the image family. If you set this parameter, the latest available image in the specified image family is used to create instances. If `ImageId` is already specified, this parameter cannot be set.	hangzhou-daily-update
ImageOwnerAlias	string	The source of the image. Valid values: system: a public image provided by Alibaba Cloud. self: a custom image that you created. others: a shared image or community image provided by other Alibaba Cloud users. marketplace: an image from Alibaba Cloud Marketplace.	system
LoadBalancerWeight	integer	The weight of the ECS instance as a backend server. Valid values: 1 to 100.	1
SystemDiskCategory	string	The category of the system cloud disk. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. ephemeral_ssd: local SSD. cloud_essd: ESSD. cloud_auto: ESSD AutoPL cloud disk.	cloud
HostName	string	The hostname of the ECS instance.	LocalHost
SystemDiskName	string	The name of the system cloud disk.	cloud_ssd_Test
InternetMaxBandwidthOut	integer	The maximum outbound public bandwidth. Unit: Mbit/s.	10
InternetMaxBandwidthIn	integer	The maximum inbound public bandwidth. Unit: Mbit/s.	10
InstanceType	string	The instance type of the ECS instance.	ecs.g6.large
InstanceDescription	string	The description of the ECS instance.	FinanceDept
IoOptimized	string	Indicates whether the instance is I/O optimized. Valid values: none: not I/O optimization. optimized: I/O optimization.	none
RamRoleName	string	The name of the RAM role associated with the ECS instance. The RAM role is provided and maintained by RAM. You can call the ListRoles operation to query available RAM roles.	ramrole****
SystemDiskPerformanceLevel	string	The performance level (PL) of the system cloud disk when the system cloud disk is an ESSD cloud disk.	PL1
Cpu	integer	The number of vCPUs. If you specify both CPU and Memory, you can define a range of instance types. For example, CPU=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, and then creates instances of the lowest-priced instance type. Note This configuration takes effect only when the cost optimization mode is enabled and no instance type is specified in the scaling configuration.	2
ResourceGroupId	string	The ID of the resource group to which the ECS instance belongs.	rg-aekzn2ou7xo****
ZoneId	string	The zone ID of the instance. You can call the DescribeZones operation to query available zones.	cn-hangzhou-g
InternetChargeType	string	The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. The value of InternetMaxBandwidthOut is the fixed bandwidth value. PayByTraffic: pay-by-traffic. The value of InternetMaxBandwidthOut is the bandwidth upper limit. Billing is based on the actual network traffic.	PayByTraffic
ImageName	string	The name of the image.	centos6u5_64_20G_aliaegis_2014****.vhd
ScalingConfigurationId	string	The ID of the scaling configuration.	asc-bp1ezrfgoyn5kijl****
CreditSpecification	string	The running mode of the burstable instance. Valid values: Standard: standard mode. For more information, see the performance constrained mode section in What are burstable instances?. Unlimited: unlimited mode. For more information, see the unlimited mode section in What are burstable instances?.	Standard
SpotInterruptionBehavior	string	The break mode of the spot instance.	Terminate
CustomPriorities	array<object>	The custom priorities of instance type + vSwitch combinations. Important This parameter takes effect only when the scaling policy of the scaling group is set to the priority policy. When an instance cannot be created by using ECS instance type + vSwitch combination with a higher priority, Auto Scaling automatically selects the next-priority combination to create ECS instance. Note If only some instance type + vSwitch combinations have custom priorities specified, 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 ECS instance type order of the scaling configuration. For example, if the vSwitch order of the scaling group is vsw1 and vsw2, ECS 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
InstanceType	string	The instance type of the ECS instance.	ecs.c6a.4xlarge
VswitchId	string	The ID of the vSwitch.	vsw-bp14zolna43z266bq****
DataDisks	array<object>	The collection of data cloud disk information.
	object	The collection of data cloud disk information.
PerformanceLevel	string	The performance level of the ESSD used as the data cloud disk when the data cloud disk is an ESSD.	PL1
Description	string	The description of the data cloud disk.	FinanceDept
SnapshotId	string	The ID of the snapshot used to create the data cloud disk.	s-23f2i****
Device	string	The mount point of the data cloud disk.	/dev/xvdb
Size	integer	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.	200
DiskName	string	The name of the data cloud disk.	cloud_ssdData
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy applied to the data cloud disk.	sp-bp19nq9enxqkomib****
Category	string	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. ephemeral_ssd: local SSD. cloud_essd: ESSD. cloud_auto: ESSD AutoPL cloud disk. cloud_regional_disk_auto: regional ESSD.	cloud
KMSKeyId	string	The ID of the KMS key associated with the data cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indicates whether the data cloud disk is released with the instance. Valid values: true: The cloud disk is released with the instance. false: The cloud disk is retained when the instance is released.	true
Encrypted	string	Indicates whether the data cloud disk is encrypted. Valid values: true: encrypted. false: not encrypted. Default value: false.	false
Categories	array	The multiple disk type list for the data cloud disk. The first disk type has the highest priority, and the priority of other disk types decreases in sequence. When a higher-priority disk type cannot be used, Auto Scaling automatically attempts the next-priority disk type to create 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 disk. cloud_regional_disk_auto: regional ESSD.
	string	The multiple disk type list for the data cloud disk. The first disk type has the highest priority, and the priority of other disk types decreases in sequence. When a higher-priority disk type cannot be used, Auto Scaling automatically attempts the next-priority disk type to create 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 disk. cloud_regional_disk_auto: regional ESSD.	cloud_essd
ProvisionedIops	integer	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 I/O operations that can be processed per second, representing the read/write capability of block storage. Unit: operations.	100
BurstingEnabled	boolean	Indicates whether the data cloud disk has Burst (performance burst) enabled. Valid values: true: enabled. false: not enabled. Note This parameter is displayed only when `DataDisk.Category` is set to `cloud_auto`.	false
Tags	array<object>	The collection of tag information.
	object	The collection of tag information.
Key	string	The tag key of the instance. Valid values of N: 1 to 20. If you specify this parameter, it cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	binary
Value	string	The tag value of the instance. Valid values of N: 1 to 20. If you specify this parameter, it can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.	alterTable
SpotPriceLimits	array<object>	The collection of spot instance information.
	object	The collection of spot instance information.
InstanceType	string	The instance type of the spot instance.	ecs.g6.large
PriceLimit	number	The price limit for the spot instance.	0.125
InstancePatternInfos	array<object>	The collection of intelligent configuration information used to filter instance types that meet the specified requirements.
	object	The collection of intelligent configuration information used to filter instance types that meet the specified requirements.
MaxPrice	number	The maximum hourly price acceptable for pay-as-you-go or spot instances.	2
Cores	integer	The number of vCPU cores of the instance type.	2
Memory	number	The memory size of the instance type. Unit: GiB.	4
InstanceFamilyLevel	string	The level of the instance family. EntryLevel: entry level, which refers to shared instance types. Lower cost but no guarantee of stable computing performance. Suitable for scenarios with low average CPU utilization. For more information, see Shared instance families. EnterpriseLevel: enterprise level. Stable performance with dedicated resources. Suitable for scenarios that require high stability. For more information, see Instance families. CreditEntryLevel: credit-based entry level, which refers to burstable instances. Uses CPU credits to ensure computing performance. Suitable for scenarios with low average CPU utilization and occasional bursts. For more information, see Burstable instances.	EnterpriseLevel
Architectures	array	The architecture types of the instance type. Valid values: X86: X86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: ECS Bare Metal Instance server. Arm: Arm computing.
	string	The architecture types of the instance type. Valid values: X86: X86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: ECS Bare Metal Instance server. Arm: Arm computing.	X86
BurstablePerformance	string	Specifies whether the instance type is a burstable instance type. Valid values: Exclude: excludes burstable instance types. Include: includes burstable instance types. Required: includes only burstable instance types.	Include
ExcludedInstanceTypes	array	The instance types to exclude. You can use wildcards () to exclude a single instance type or an entire instance family. For example: ecs.c6.large: excludes the ecs.c6.large instance type. ecs.c6.: excludes the entire c6 instance family.
	string	The instance types to exclude. You can use wildcards () to exclude a single instance type or an entire instance family. For example: 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	The instance families to query. N indicates that multiple instance families can be specified. Valid values of N: 1 to 10.
	string	The instance families to query. N indicates that multiple instance families can be specified. Valid values of N: 1 to 10.	ecs.g6
MinimumCpuCoreCount	integer	The minimum number of vCPU cores of the instance type.	2
MaximumCpuCoreCount	integer	The maximum number of vCPU cores of the instance type. Note MaximumCpuCoreCount cannot exceed 4 times the value of MinimumCpuCoreCount.	4
GpuSpecs	array	The GPU types.
	string	The GPU types.	NVIDIA V100
InstanceCategories	array	The instance categorization. Valid values: Note N indicates that multiple instance categories can be set. Valid values of N: 1 to 10. General-purpose: general-purpose. Compute-optimized: compute-optimized. Memory-optimized: memory-optimized. Big data: big data. Local SSDs: local SSD. High Clock Speed: high frequency. Enhanced: enhanced. Shared: shared. Compute-optimized with GPU: GPU computing. Visual Compute-optimized: visual compute-optimized. Heterogeneous Service: heterogeneous service. Compute-optimized with FPGA: FPGA-accelerated compute-optimized. Compute-optimized with NPU: NPU-accelerated compute-optimized. ECS Bare Metal: ECS Bare Metal Instance server. High Performance Compute: high-performance computing (HPC).
	string	The instance categorization. Valid values: Note N indicates that multiple instance categories can be set. Valid values of N: 1 to 10. General-purpose: general-purpose. Compute-optimized: compute-optimized. Memory-optimized: memory-optimized. Big data: big data. Local SSDs: local SSD. High Clock Speed: high frequency. Enhanced: enhanced. Shared: shared. Compute-optimized with GPU: GPU computing. Visual Compute-optimized: visual compute-optimized. Heterogeneous Service: heterogeneous service. Compute-optimized with FPGA: FPGA-accelerated compute-optimized. Compute-optimized with NPU: NPU-accelerated compute-optimized. ECS Bare Metal: ECS Bare Metal Instance server. High Performance Compute: high-performance computing (HPC).	Compute-optimized with GPU
CpuArchitectures	array	The CPU architectures of the instance type. Valid values: Note N indicates that multiple CPU architectures can be specified. Valid values of N: 1 to 2. X86. ARM.
	string	The CPU architecture of the instance. Valid values: Note N indicates that multiple CPU architectures can be specified. Valid values of N: 1 to 2. X86. ARM.	X86
PhysicalProcessorModels	array	The processor models of the instance. N indicates that multiple processor models can be specified. Valid values of N: 1 to 10.
	string	The processor models of the instance. N indicates that multiple processor models can be specified. Valid values of N: 1 to 10.	Intel Xeon(Ice Lake) Platinum 8369B
MinimumEniQuantity	integer	The minimum upper limit of network interface controllers (NICs) that the instance supports.	2
MinimumEniPrivateIpAddressQuantity	integer	The minimum upper limit of IPv4 addresses per network interface controller (NIC) that the instance supports.	2
MinimumEniIpv6AddressQuantity	integer	The minimum upper limit of IPv6 addresses per network interface controller (NIC) that the instance supports.	1
MinimumInitialCredit	integer	The minimum initial vCPU credits for burstable instances (t5 and t6).	12
MinimumBaselineCredit	integer	The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable instances (t5 and t6).	12
MinimumMemorySize	number	The minimum memory size of the instance. Unit: GiB.	4
MaximumMemorySize	number	The maximum memory size of the instance. Unit: GiB.	4
MinimumGpuAmount	integer	The minimum number of GPUs of the instance. Valid values: positive integers.	2
MaximumGpuAmount	integer	The maximum number of GPUs of the instance. Valid values: positive integers.	2
SystemDiskCategories	array	The multiple disk type list for the system cloud disk. The first disk type has the highest priority, and the priority decreases for subsequent disk types. When a higher-priority disk type 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: ESSD.
	string	The multiple disk type list for the system cloud disk. The first disk type has the highest priority, and the priority decreases for subsequent disk types. When a higher-priority disk type 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: ESSD.	cloud
WeightedCapacities	array	The weights of the specified instance types. The weight indicates the capacity that a single instance of the specified instance type represents in the scaling group. A higher weight means fewer instances of this type are required to meet the expected capacity.
	integer	The weights of the specified instance types. The weight indicates the capacity that a single instance of the specified instance type represents in the scaling group. A higher weight means fewer instances of this type are required to meet the expected capacity.	4
InstanceTypes	array	The collection of instance types of the ECS instance.
	string	The collection of instance types of the ECS instance.	ecs.g6.large
SecurityGroupIds	array	The IDs of the multiple security groups to which the ECS instance belongs. ECS instances in the same security group can access each other.
	string	The IDs of the multiple security groups to which the ECS instance belongs. ECS instances in the same security group can access each other.	sg-bp18kz60mefs****
SchedulerOptions	object	Note This parameter is in invitational preview and is not publicly available.
ManagedPrivateSpaceId	string	Note This parameter is in invitational preview and is not publicly available.	testManagedPrivateSpaceId
SystemDiskEncrypted	boolean	Indicates whether the system cloud disk is encrypted. Valid values: true: encrypted. false: not encrypted.	false
SystemDiskKMSKeyId	string	The ID of the KMS key used for the system cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
SystemDiskEncryptAlgorithm	string	The encryption algorithm used for the system cloud disk. Valid values: AES-256. SM4-128.	AES-256
SystemDiskProvisionedIops	integer	The provisioned IOPS (Input/Output Operations Per Second) performance metrics of the system cloud disk. Note IOPS (Input/Output Operations Per Second) measures the number of I/O operations that can be processed per second, indicating the read/write capability of block storage.	100
SystemDiskBurstingEnabled	boolean	Indicates whether the Burst (performance burst) feature is enabled for the system cloud disk. Valid values: true: enabled. false: not enabled. Note This parameter is supported only when SystemDisk.Category is set to cloud_auto.	false
ImageOptionsLoginAsNonRoot	boolean	Indicates whether the ECS instance uses the ecs-user user for logon. Valid values: true: yes. false: no.	false
DeletionProtection	boolean	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. Valid values: true: Release protection is enabled. The instance cannot be directly released from the ECS console or by calling the DeleteInstance operation. false: Release protection is disabled. 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 and prevents instances scaled out by Auto Scaling from being accidentally deleted. It does not affect normal scale-in activities. Instances with release protection enabled can still be released by scale-in activities.	false
StorageSetId	string	The ID of the storage set.	ss-bp67acfmxazb4p****
StorageSetPartitionNumber	integer	The maximum number of partitions in the storage set. Valid values: integers greater than or equal to 2.	2
NetworkInterfaces	array<object>	The list of elastic network interfaces (ENIs).
	object	The elastic network interface (ENI).
InstanceType	string	The type of the elastic network interface (ENI). Valid values: Primary: primary network interface controller (NIC). Secondary: secondary elastic network interface (ENI).	Primary
NetworkInterfaceTrafficMode	string	The communication mode of the elastic network interface (ENI). Valid values: Standard: uses the TCP communication mode. HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.	HighPerformance
Ipv6AddressCount	integer	The number of randomly generated IPv6 addresses allocated to the primary ENI.	1
SecurityGroupIds	array	The IDs of one or more security groups to which the elastic network interface (ENI) belongs.
	string	The IDs of one or more security groups to which the elastic network interface (ENI) belongs.	sg-2vc3e1v7xxxxx
SecondaryPrivateIpAddressCount	integer	The number of secondary private IPv4 addresses assigned to the ENI. Valid values: 1 to 49. The value cannot exceed the maximum number of IP addresses allowed for the instance type. For more information, see Instance families. NetworkInterface.N.SecondaryPrivateIpAddressCount specifies the number of secondary private IPv4 addresses assigned 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) associated with the ENI.	2
VSwitchIds	array
	string		vsw-bp67acfmxazb4p****
DedicatedHostClusterId	string	The ID of the dedicated host cluster.	dc-zm04u8r3lohsq****
PasswordSetted	boolean	Indicates whether an instance password is set. Valid values: true: An instance password is set. false: No instance password is set.	false
SecurityOptions	object	The security options.
ConfidentialComputingMode	string	The confidential computing mode. Valid values: Enclave: The ECS instance uses Enclave to build a confidential computing environment. For more information, see Build a confidential computing environment by using Enclave. TDX: A TDX confidential computing environment is built. For more information, see Build a TDX confidential computing environment.	TDX
HttpEndpoint	string	Indicates whether the access channel for instance metadata is enabled. Valid values: enabled: Enabled. disabled: Disabled.	enabled
HttpTokens	string	Indicates whether the China mode (IMDSv2) is forcefully used when accessing instance metadata. Valid values: optional: Not forcefully used. required: Forcefully used. After this value is set, instance metadata cannot be accessed in normal mode.	optional
ResourcePoolOptions	object	The resource pool policy used when creating instances. This parameter takes effect only when pay-as-you-go instances are created.
Strategy	string	The resource pool includes private pools generated by elasticity assurance or capacity reservation, and public pools for instance startup. Valid values: PrivatePoolFirst: Private pool first. When this strategy is selected and ResourcePoolOptions.PrivatePoolIds is specified or PrivatePoolTags conditions are met, the corresponding private pool is used first. If no private pool is specified or the specified private pool has insufficient capacity, open-type private pools are automatically matched. If no matching private pool is available, the public pool is used to create instances. PrivatePoolOnly: Private pool only. When this strategy is selected, ResourcePoolOptions.PrivatePoolIds must be specified. If the specified private pool has insufficient capacity, instance startup fails. 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 matching private pool is available, the Target-type private pools specified in ResourcePoolOptions.PrivatePoolIds or matching PrivatePoolTags conditions are used. None: No resource pool policy is used.	PrivatePoolFirst
PrivatePoolIds	array	The private pool IDs, which are the elasticity assurance IDs or capacity reservation IDs.
	string	The private pool IDs, which are the elasticity assurance IDs or capacity reservation IDs.	eap-bp67acfmxazb4****
PrivatePoolTags	array<object>	The tags used to filter available Target-type private pools.
	object	The tags used to filter available Target-type private pools.
Key	string	The tag key of the private pool.	TestKey
Value	string	The tag value of the private pool.	TestValue
InstanceTypeCandidateOptions	object	After the candidate mode is enabled, when issues such as insufficient inventory occur, similar instance types of the same size are supplemented based on the currently selected instance types, or vSwitches in candidate zones are created and added to the scaling group.
Enabled	boolean	Indicates whether the candidate mode is enabled.	true
MaxPrice	number	The maximum price for candidate instance types.	2
AllowDifferentGeneration	boolean	Indicates whether instance types of other generations are allowed as candidates. For example, if the current instance type is ecs.c7.large, enabling this option allows candidate instance types such as ecs.c6.large and ecs.c8.large.	true
AllowCrossAz	boolean	Indicates whether vSwitches in other zones are allowed as candidates. Note The instance type remains unchanged. Only new zones are selected as candidates. When all selected zones in the scaling group cannot be used for scale-out due to issues such as insufficient inventory, new vSwitches in other zones 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	The CIDR blocks for candidate vSwitches in other zones when cross-zone supplementation is allowed.
	string	The CIDR blocks for candidate vSwitches in other zones when cross-zone supplementation is allowed.	172.16.0.0/24
CpuOptions	object	The CPU options.
NestedVirtualization	string	Indicates whether hardware-based nested virtualization is enabled. Valid values: enabled disabled	enabled
SecondaryEniVSwitchConstraint	string	Indicates whether a vSwitch that is available for secondary elastic network interfaces (ENIs) must be selected from the list specified by the VSwitchIds parameter.	Strict

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScalingConfigurations": [
    {
      "DeploymentSetId": "ds-bp1frxuzdg87zh4p****",
      "CreationTime": "2014-08-14T10:58Z",
      "ScalingConfigurationName": "scalingconfigura****",
      "SystemDiskDescription": "Test system disk.",
      "KeyPairName": "keypair****",
      "SecurityGroupId": "sg-bp18kz60mefs****",
      "PrivatePoolOptions.Id": "eap-bp67acfmxazb4****",
      "SystemDiskAutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
      "SpotStrategy": "NoSpot",
      "ScalingGroupId": "asg-bp17pelvl720x3v7****",
      "Affinity": "default",
      "Tenancy": "default",
      "SystemDiskSize": 100,
      "Ipv6AddressCount": 1,
      "SpotDuration": 1,
      "LifecycleState": "Active",
      "InstanceName": "instance****",
      "SecurityEnhancementStrategy": "Active",
      "UserData": "echo hello ecs!\t\n",
      "PrivatePoolOptions.MatchCriteria": "Open",
      "DedicatedHostId": "dh-bp67acfmxazb4p****",
      "InstanceGeneration": "ecs-3",
      "HpcClusterId": "hpc-clus****",
      "PasswordInherit": true,
      "Memory": 16,
      "ImageId": "centos6u5_64_20G_aliaegis_2014****.vhd",
      "ImageFamily": "hangzhou-daily-update",
      "ImageOwnerAlias": "system",
      "LoadBalancerWeight": 1,
      "SystemDiskCategory": "cloud",
      "HostName": "LocalHost",
      "SystemDiskName": "cloud_ssd_Test",
      "InternetMaxBandwidthOut": 10,
      "InternetMaxBandwidthIn": 10,
      "InstanceType": "ecs.g6.large",
      "InstanceDescription": "FinanceDept",
      "IoOptimized": "none",
      "RamRoleName": "ramrole****",
      "SystemDiskPerformanceLevel": "PL1",
      "Cpu": 2,
      "ResourceGroupId": "rg-aekzn2ou7xo****",
      "ZoneId": "cn-hangzhou-g",
      "InternetChargeType": "PayByTraffic",
      "ImageName": "centos6u5_64_20G_aliaegis_2014****.vhd\t\n",
      "ScalingConfigurationId": "asc-bp1ezrfgoyn5kijl****",
      "CreditSpecification": "Standard",
      "SpotInterruptionBehavior": "Terminate",
      "CustomPriorities": [
        {
          "InstanceType": "ecs.c6a.4xlarge",
          "VswitchId": "vsw-bp14zolna43z266bq****\n"
        }
      ],
      "DataDisks": [
        {
          "PerformanceLevel": "PL1",
          "Description": "FinanceDept",
          "SnapshotId": "s-23f2i****",
          "Device": "/dev/xvdb",
          "Size": 200,
          "DiskName": "cloud_ssdData",
          "AutoSnapshotPolicyId": "sp-bp19nq9enxqkomib****",
          "Category": "cloud",
          "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
          "DeleteWithInstance": true,
          "Encrypted": "false",
          "Categories": [
            "cloud_essd"
          ],
          "ProvisionedIops": 100,
          "BurstingEnabled": false
        }
      ],
      "Tags": [
        {
          "Key": "binary",
          "Value": "alterTable"
        }
      ],
      "SpotPriceLimits": [
        {
          "InstanceType": "ecs.g6.large\t\n",
          "PriceLimit": 0.125
        }
      ],
      "InstancePatternInfos": [
        {
          "MaxPrice": 2,
          "Cores": 2,
          "Memory": 4,
          "InstanceFamilyLevel": "EnterpriseLevel",
          "Architectures": [
            "X86"
          ],
          "BurstablePerformance": "Include",
          "ExcludedInstanceTypes": [
            "ecs.n1.small/ecs.n1.*/*7*"
          ],
          "InstanceTypeFamilies": [
            "ecs.g6"
          ],
          "MinimumCpuCoreCount": 2,
          "MaximumCpuCoreCount": 4,
          "GpuSpecs": [
            "NVIDIA V100"
          ],
          "InstanceCategories": [
            "Compute-optimized with GPU"
          ],
          "CpuArchitectures": [
            "X86"
          ],
          "PhysicalProcessorModels": [
            "Intel Xeon(Ice Lake) Platinum 8369B"
          ],
          "MinimumEniQuantity": 2,
          "MinimumEniPrivateIpAddressQuantity": 2,
          "MinimumEniIpv6AddressQuantity": 1,
          "MinimumInitialCredit": 12,
          "MinimumBaselineCredit": 12,
          "MinimumMemorySize": 4,
          "MaximumMemorySize": 4,
          "MinimumGpuAmount": 2,
          "MaximumGpuAmount": 2
        }
      ],
      "SystemDiskCategories": [
        "cloud"
      ],
      "WeightedCapacities": [
        4
      ],
      "InstanceTypes": [
        "ecs.g6.large"
      ],
      "SecurityGroupIds": [
        "sg-bp18kz60mefs****"
      ],
      "SchedulerOptions": {
        "ManagedPrivateSpaceId": "testManagedPrivateSpaceId"
      },
      "SystemDiskEncrypted": false,
      "SystemDiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****\t\n",
      "SystemDiskEncryptAlgorithm": "AES-256\t\n",
      "SystemDiskProvisionedIops": 100,
      "SystemDiskBurstingEnabled": false,
      "ImageOptionsLoginAsNonRoot": false,
      "DeletionProtection": false,
      "StorageSetId": "ss-bp67acfmxazb4p****",
      "StorageSetPartitionNumber": 2,
      "NetworkInterfaces": [
        {
          "InstanceType": "Primary",
          "NetworkInterfaceTrafficMode": "HighPerformance",
          "Ipv6AddressCount": 1,
          "SecurityGroupIds": [
            "sg-2vc3e1v7xxxxx"
          ],
          "SecondaryPrivateIpAddressCount": 2,
          "VSwitchIds": [
            "vsw-bp67acfmxazb4p****"
          ]
        }
      ],
      "DedicatedHostClusterId": "dc-zm04u8r3lohsq****",
      "PasswordSetted": false,
      "SecurityOptions": {
        "ConfidentialComputingMode": "TDX"
      },
      "HttpEndpoint": "enabled",
      "HttpTokens": "optional",
      "ResourcePoolOptions": {
        "Strategy": "PrivatePoolFirst",
        "PrivatePoolIds": [
          "eap-bp67acfmxazb4****"
        ],
        "PrivatePoolTags": [
          {
            "Key": "TestKey",
            "Value": "TestValue"
          }
        ]
      },
      "InstanceTypeCandidateOptions": {
        "Enabled": true,
        "MaxPrice": 2,
        "AllowDifferentGeneration": true,
        "AllowCrossAz": true,
        "AllowCidrBlocks": [
          "172.16.0.0/24\n"
        ]
      },
      "CpuOptions": {
        "NestedVirtualization": "enabled"
      },
      "SecondaryEniVSwitchConstraint": "Strict"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.