DescribeScalingConfigurations - Auto Scaling - Alibaba Cloud ドキュメントセンター

Queries scaling configurations.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ess:DescribeScalingConfigurations	get	*ScalingGroup `acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group to which the scaling configuration that you want to query belongs.	cn-qingdao
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	50
ScalingGroupId	string	No	The ID of the scaling group. You can use the ID to query all scaling configurations in the scaling group.	asg-bp17pelvl720x3v7****
ScalingConfigurationIds	array	No	The IDs of the scaling configurations that you want to query. The IDs of active and inactive scaling configurations are displayed in the query results. You can differentiate between active and inactive scaling configurations based on the value of the `LifecycleState` parameter.
	string	No	The IDs of the scaling configurations that you want to query. The IDs of active and inactive scaling configurations are displayed in the query results. You can differentiate between active and inactive scaling configurations based on the value of the `LifecycleState` parameter.	asc-bp17pelvl720x5ub****
ScalingConfigurationNames	array	No	The names of the scaling configurations that you want to query. The names of inactive scaling configurations are not displayed in the query results, and no error is reported.
	string	No	The names of the scaling configurations that you want to query. The names of inactive scaling configurations are not displayed in the query results, and no error is reported.	scalingcon****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of scaling configurations.	1
ScalingConfigurations	array<object>	The scaling configurations.
ScalingConfiguration	object	The scaling configuration.
DeploymentSetId	string	The ID of the deployment set to which the Elastic Compute Service (ECS) instances belong.	ds-bp1frxuzdg87zh4p****
CreationTime	string	The time at which 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 disk.	Test system disk.
KeyPairName	string	The name of the key pair that is used to log on to an ECS instance created from the scaling configuration.	keypair****
SecurityGroupId	string	The ID of the security group to which the ECS instances belong. ECS instances that belong to the same security group can communicate with each other.	sg-bp18kz60mefs****
PrivatePoolOptions.Id	string	The ID of the private pool, which is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.	eap-bp67acfmxazb4****
SystemDiskAutoSnapshotPolicyId	string	The ID of the automatic snapshot policy that is applied to the system disk.	sp-bp12m37ccmxvbmi5****
SpotStrategy	string	The preemption policy that is applied to pay-as-you-go instances. Valid values: NoSpot: The instances are created as regular pay-as-you-go instances. SpotWithPriceLimit: The instances are created as preemptible instances that have a user-defined maximum hourly price. SpotAsPriceGo: The instances are preemptible instances for which the market price at the time of purchase is automatically used as the bid price.	NoSpot
ScalingGroupId	string	The ID of the scaling group to which the scaling configuration belongs.	asg-bp17pelvl720x3v7****
Affinity	string	Indicates whether the ECS instance on a dedicated host is associated 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 and the original dedicated host of the instance has insufficient resources, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool. host: The instance is associated with the dedicated host. If you restart an instance that was stopped in Economical Mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot be restarted.	default
Tenancy	string	Indicates whether the ECS instance is created on a dedicated host. Valid values: default: The ECS instance is created on a non-dedicated host. host: The ECS instance is created on a dedicated host. If you do not specify DedicatedHostId, the system selects a dedicated host for the ECS instance. Default value: default.	default
SystemDiskSize	integer	The size of the system disk. Unit: GiB.	100
Ipv6AddressCount	integer	The number of randomly generated IPv6 addresses that are allocated to the elastic network interface (ENI).	1
SpotDuration	integer	The protection period of the preemptible instances. Unit: hours.	1
LifecycleState	string	The status of the scaling configuration in the scaling group. Valid values: Active: The scaling configuration is active in the scaling group. Auto Scaling uses the scaling configuration that is in the Active state to create ECS instances during scale-out events. Inactive: The scaling configuration is inactive in the scaling group. Scaling configurations that are in the Inactive state are still contained in the scaling group, but Auto Scaling does not use the inactive scaling configurations to create ECS instances during scale-out events.	Active
InstanceName	string	The naming series of the ECS instances.	instance****
SecurityEnhancementStrategy	string	Indicates whether Security Hardening is enabled. Valid values: Active: Security Hardening is enabled. This value is applicable to only public images. Deactive: Security Hardening is disabled. This value is applicable to all images.	Active
UserData	string	The user data of the ECS instances.	echo hello ecs!
PrivatePoolOptions.MatchCriteria	string	The type of the private pool. A private pool is generated when an elasticity assurance or a capacity reservation takes effect. You can specify a private pool for Auto Scaling to start instances. Valid values: Open: open private pool. Auto Scaling selects a matching open private pool to start instances. If no matching open private pools exist, Auto Scaling uses the resources in the public pool to start instances. Target: specified private pool. Auto Scaling uses the resources in the specified private pool to start instances. If the resources in the specified private pool are insufficient, instances cannot be started. None: no private pool. Auto Scaling does not use the resources in private pools to start instances.	Open
DedicatedHostId	string	The ID of the dedicated host on which the ECS instance is created. Preemptible instances are not supported by dedicated hosts. Therefore, if you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are ignored. You can call the DescribeDedicatedHosts operation to query the IDs of dedicated hosts.	dh-bp67acfmxazb4p****
InstanceGeneration	string	The generation of the ECS instances.	ecs-3
HpcClusterId	string	The ID of the High Performance Computing (HPC) cluster to which the ECS instances belong.	hpc-clus****
PasswordInherit	boolean	Indicates whether the password preconfigured in the image is used.	true
Memory	integer	The memory size. Unit: GiB. You can specify CPU and Memory to define the range of instance types. For example, if you set CPU to 2 and Memory to 16, the instance types that have 2 vCPUs and 16 GiB are returned. If you specify CPU and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones and preferentially creates instances by using the lowest-priced instance type. Note You can specify CPU and Memory to define instance types only when you set Scaling Policy to Cost Optimization and no instance type is specified in the scaling configuration.	16
ImageId	string	The ID of the image file that provides the image resource for Auto Scaling to create ECS instances.	centos6u5_64_20G_aliaegis_2014****.vhd
ImageFamily	string	The name of the image family. You can specify this parameter to obtain the latest available images in the current image family for instance creation. If you specify ImageId, you cannot specify `ImageFamily`.	hangzhou-daily-update
ImageOwnerAlias	string	The image source. Valid values: system: a public image provided by Alibaba Cloud self: a custom image that you created others: a shared image from another Alibaba Cloud account or a community image published by another Alibaba Cloud account marketplace: an Alibaba Cloud Marketplace image	system
LoadBalancerWeight	integer	The weight of an ECS instance as a backend server. Valid values: 1 to 100.	1
SystemDiskCategory	string	The category of the system disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral_ssd: local SSD cloud_essd: enterprise SSD (ESSD) cloud_auto: ESSD AutoPL	cloud
HostName	string	The hostname series of the ECS instances.	LocalHost
SystemDiskName	string	The name of the system disk.	cloud_ssd_Test
InternetMaxBandwidthOut	integer	The maximum outbound public bandwidth. Unit: Mbit/s.	0
InternetMaxBandwidthIn	integer	The maximum inbound public bandwidth. Unit: Mbit/s.	200
InstanceType	string	The instance types of the ECS instances.	ecs.g6.large
InstanceDescription	string	The description of the ECS instances.	FinanceDept
IoOptimized	string	Indicates whether the ECS instances are I/O optimized. Valid values: none: The ECS instances are not I/O optimized. optimized: The ECS instances are I/O optimized.	none
RamRoleName	string	The name of the Resource Access Management (RAM) role assumed by the ECS instances. This name is provided and maintained by RAM. You can call the ListRoles operation to query the available RAM roles.	ramrole****
SystemDiskPerformanceLevel	string	The performance level (PL) of the system disk that is an ESSD.	PL1
Cpu	integer	The number of vCPUs. You can specify CPU and Memory to define the range of instance types. For example, if you set CPU to 2 and Memory to 16, the instance types that have 2 vCPUs and 16 GiB are returned. If you specify CPU and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones and preferentially creates instances by using the lowest-priced instance type. Note You can specify CPU and Memory to define instance types only when you set Scaling Policy to Cost Optimization and no instance type is specified in the scaling configuration.	2
ResourceGroupId	string	The ID of the resource group to which the ECS instances belong.	rg-aekzn2ou7xo****
ZoneId	string	The ID of the zone in which the ECS instances are created. You can call the DescribeZones operation to query the zone IDs.	cn-hangzhou-g
InternetChargeType	string	The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. You are charged for the bandwidth that you specified by using InternetMaxBandwidthOut. PayByTraffic: pay-by-traffic. You are charged for the actual traffic that you used. InternetMaxBandwidthOut specifies only the maximum available bandwidth.	PayByTraffic
ImageName	string	The name of the image file.	centos6u5_64_20G_aliaegis_2014****.vhd
ScalingConfigurationId	string	The ID of the scaling configuration.	asc-bp1ezrfgoyn5kijl****
CreditSpecification	string	The performance mode of the burstable instances. Valid values: Standard: the standard mode. For more information, see the "Standard mode" section in the Overview of burstable instances topic. Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section in Overview of burstable instances.	Standard
SpotInterruptionBehavior	string	The interruption event of the preemptible instances.	Terminate
CustomPriorities	array<object>	The priority of the custom ECS instance type + vSwitch combination. Note This parameter takes effect only when Scaling Policy of the scaling group is set to Priority Policy. If Auto Scaling cannot create ECS instances by using the custom ECS instance type + vSwitch combination of the highest priority, Auto Scaling creates ECS instances by using the custom ECS instance type + vSwitch combination of the next highest priority. Note If you specify the priorities of only a portion of custom ECS instance type + vSwitch combinations, Auto Scaling preferentially creates ECS instances by using the custom combinations that have specified priorities. If the custom combinations that have specified priorities do not provide sufficient resources, Auto Scaling creates ECS instances by using the custom combinations that do not have specified priorities based on the specified orders of vSwitches and instance types. Example: the specified order of vSwitches for your scaling group is vsw1 and vsw2 and the specified order of instance types in your scaling configuration is type1 and type 2. In addition, you use CustomPriorities to specify ["vsw2+type2", "vsw1+type2"]. In this example, the vsw2+type2 combination has the highest priority and the vsw2+type1 combination has the lowest priority. The vsw1+type2 combination has a higher priority than the vsw1+type1 combination.
CustomPriority	object
InstanceType	string	The ECS instance type.	ecs.c6a.4xlarge
VswitchId	string	The vSwitch ID.	vsw-bp14zolna43z266bq****
DataDisks	array<object>	The data disks.
DataDisk	object	Details of the data disks.
PerformanceLevel	string	The PL of the data disk that is an ESSD.	PL1
Description	string	The description of the data disk.	FinanceDept
SnapshotId	string	The ID of the snapshot based on which the data disk is created.	s-23f2i****
Device	string	The mount target of the data disk.	/dev/xvdb
Size	integer	The size of the data disk. Unit: GB. Valid values: 5 to 2000 if you set Category to cloud. 20 to 32768 if you set Category to cloud_efficiency. 20 to 32768 if you set Category to cloud_ssd. 20 to 32768 if you set Category to cloud_essd. 5 to 800 if you set Category to ephemeral_ssd.	200
DiskName	string	The name of the data disk.	cloud_ssdData
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy that is applied to the data disk.	sp-bp19nq9enxqkomib****
Category	string	The category of the data disk. Valid values: cloud: basic disk. DeleteWithInstance of a basic disk created along with the ECS instance is set to true. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. ephemeral_ssd: local SSD. cloud_essd: ESSD. cloud_auto: ESSD AutoPL.	cloud
KMSKeyId	string	The ID of the Key Management Service (KMS) key that is applied to the data disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indicates whether the data disk is released when the instance to which the data disk is attached is released. Valid values: true false	true
Encrypted	string	Indicates whether the data disk is encrypted. Valid values: true false Default value: false.	false
Categories	array	The categories of the data disks. The values are sorted based on their priorities. The first value has the highest priority. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values: cloud: basic disk. DeleteWithInstance of a basic disk created along with the ECS instance is set to true. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.
Category	string	The category of the data disk. The values are sorted based on their priorities. The first value has the highest priority. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values: cloud: basic disk. DeleteWithInstance of a basic disk created along with the ECS instance is set to true. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.	cloud_essd
ProvisionedIops	long	The provisioned IOPS of the data disk. Note IOPS measures the number of read and write operations that an Elastic Block Storage (EBS) device can process per second.	100
BurstingEnabled	boolean	Indicates whether the Performance Burst feature is enabled for the data disk. Valid values: true false Note This parameter is available only when you set `DataDisk.Category` to `cloud_auto`.	false
Tags	array<object>	The tags.
Tag	object	Details of the tags.
Key	string	The tag key of the ECS instance. You can specify up to 20 tags for each ECS instance. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `acs:` or `aliyun` and cannot contain `http://` or `https://`.	binary
Value	string	The tag value of the ECS instance. You can specify up to 20 tags for each ECS instance. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `acs:` and cannot contain `http://` or `https://`.	alterTable
SpotPriceLimits	array<object>	The preemptible instances.
SpotPriceModel	object	Details of the preemptible instances.
InstanceType	string	The instance type of the preemptible instances.	ecs.g6.large
PriceLimit	float	The price limit of the preemptible instances.	0.125
InstancePatternInfos	array<object>	The intelligent configuration settings, which determine the available instance types.
InstancePatternInfo	object	The intelligent configuration setting, which determines the available instance types.
MaxPrice	float	The maximum hourly price for the pay-as-you-go or preemptible instances.	2
Cores	integer	The number of vCPUs of the instance type.	2
Memory	float	The memory size of the instance type. Unit: GiB.	4
InstanceFamilyLevel	string	The level of the instance family. EntryLevel: entry level (shared instance types). Instance types of this level are the most cost-effective but may not provide stable computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low. For more information, see Shared instance families. EnterpriseLevel: enterprise level. Instance types of this level provide stable performance and dedicated resources, and are suitable for scenarios that require high stability. For more information, see Overview of instance families. CreditEntryLevel: credit entry level (burstable instance types). CPU credits are used to ensure computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see Overview of burstable instances.	EnterpriseLevel
Architectures	array	The architectures of instance types. Valid values: X86: x86. Heterogeneous: heterogeneous computing, such as GPU-accelerated or FPGA-accelerated. BareMetal: ECS Bare Metal Instance. Arm: Arm.
Architecture	string	The architecture of the instance type. Valid values: X86: x86. Heterogeneous: heterogeneous computing, such as GPU-accelerated or FPGA-accelerated. BareMetal: ECS Bare Metal Instance. Arm: Arm.	X86
BurstablePerformance	string	Indicates whether burstable instance types are included. Valid values: Exclude: Burstable instance types are not included. Include: Burstable instance types are included. Required: Only burstable instance types are included.	Include
ExcludedInstanceTypes	array	The instance types that are excluded. You can use wildcard characters, such as an asterisk (), to exclude an instance type or an instance family. Examples: ecs.c6.large: The ecs.c6.large instance type is excluded. ecs.c6.: The c6 instance family is excluded.
ExcludedInstanceType	string	The instance type that is excluded. You can use wildcard characters, such as an asterisk (), to exclude an instance type or an instance family. Examples: ecs.c6.large: The ecs.c6.large instance type is excluded. ecs.c6.: The c6 instance family is excluded.	ecs.n1.small/ecs.n1./7*
InstanceTypeFamilies	array	The instance families that are queried. You can query 1 to 10 instance families in each call.
InstanceTypeFamily	string	The instance family that is queried. You can query 1 to 10 instance families in each call.	ecs.g6
MinimumCpuCoreCount	integer	The minimum number of vCPUs per instance type.	2
MaximumCpuCoreCount	integer	The maximum number of vCPUs per instance type. Note The value of MaximumCpuCoreCount cannot exceed four times the value of MinimumCpuCoreCount.	4
GpuSpecs	array	The GPU models.
GpuSpec	string	The GPU model.	NVIDIA V100
InstanceCategories	array	The categories of ECS instances. Valid values: Note Up to 10 categories of ECS instances are supported. General-purpose: general-purpose instance type. Compute-optimized: compute-optimized instance type. Memory-optimized: memory-optimized instance type. Big data: big data instance type. Local SSDs: instance type with local SSDs. High Clock Speed: instance type with high clock speeds. Enhanced: enhanced instance type. Shared: shared instance type. Compute-optimized with GPU: GPU-accelerated compute-optimized instance type. Visual Compute-optimized: visual compute-optimized instance type. Heterogeneous Service: heterogeneous service instance type. Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type. Compute-optimized with NPU: NPU-accelerated compute-optimized instance type. ECS Bare Metal: ECS Bare Metal Instance type. High Performance Compute: HPC-optimized instance type.
InstanceCategory	string	The category of the ECS instance. Valid values: Note Up to 10 categories of ECS instances are supported. General-purpose: general-purpose instance type. Compute-optimized: compute-optimized instance type. Memory-optimized: memory-optimized instance type. Big data: big data instance type. Local SSDs: instance type with local SSDs. High Clock Speed: instance type with high clock speeds. Enhanced: enhanced instance type. Shared: shared instance type. Compute-optimized with GPU: GPU-accelerated compute-optimized instance type. Visual Compute-optimized: visual compute-optimized instance type. Heterogeneous Service: heterogeneous service instance type. Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type. Compute-optimized with NPU: NPU-accelerated compute-optimized instance type. ECS Bare Metal: ECS Bare Metal Instance type. High Performance Compute: HPC-optimized instance type.	Compute-optimized with GPU
CpuArchitectures	array	The CPU architectures of the instance types. Valid values: Note You can specify 1 to 2 CPU architectures. x86 Arm
CpuArchitecture	string	The CPU architecture of the instance type. Valid values: Note You can specify 1 to 2 CPU architectures. x86 ARM	X86
PhysicalProcessorModels	array	The processor models of the instance types. You can specify 1 to 10 processor models.
PhysicalProcessorModel	string	The processor model of the instance type. You can specify 1 to 10 processor models.	Intel Xeon(Ice Lake) Platinum 8369B
MinimumEniQuantity	integer	The minimum number of elastic network interfaces (ENIs) per instance.	2
MinimumEniPrivateIpAddressQuantity	integer	The minimum number of IPv4 addresses per ENI.	2
MinimumEniIpv6AddressQuantity	integer	The minimum number of IPv6 addresses per ENI.	1
MinimumInitialCredit	integer	The initial vCPU credits per t5 or t6 burstable instance.	12
MinimumBaselineCredit	integer	The baseline vCPU computing performance (overall baseline performance of all vCPUs) per t5 or t6 burstable instance.	12
MinimumMemorySize	float	The minimum memory size per instance. Unit: GiB.	4
MaximumMemorySize	float	The maximum memory size per instance. Unit: GiB.	4
MinimumGpuAmount	integer	The minimum number of GPUs per instance. The value must be a positive integer.	2
MaximumGpuAmount	integer	The maximum number of GPUs per instance. The value must be a positive integer.	2
SystemDiskCategories	array	The categories of the system disks. The values are sorted based on their priorities. The first value has the highest priority. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD
SystemDiskCategory	string	The category of the system disk. The values are sorted based on their priorities. The first value has the highest priority. If Auto Scaling cannot create instances by using the disk category of the highest priority, Auto Scaling creates instances by using the disk category of the next highest priority. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD	cloud
WeightedCapacities	array	The weights of the instance types. The value of this parameter indicates the capacity of an instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the instance type are required to meet the expected capacity requirement.
WeightedCapacity	integer	The weight of the instance type. The value of this parameter indicates the capacity of an instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the instance type are required to meet the expected capacity requirement.	4
InstanceTypes	array	The ECS instance types.
InstanceType	string	The ECS instance type.	ecs.g6.large
SecurityGroupIds	array	The IDs of the security groups to which the ECS instances belong. ECS instances that belong to the same security group can communicate with each other.
SecurityGroupId	string	The ID of the security group to which the ECS instance belongs. ECS instances that belong to the same security group can communicate with each other.	sg-bp18kz60mefs****
SchedulerOptions	object	Note This parameter is in invitational preview and is not available for use.
ManagedPrivateSpaceId	string	Note This parameter is in invitational preview and is not available for use.	testManagedPrivateSpaceId
SystemDiskEncrypted	boolean	Indicates whether the system disk is encrypted. Valid values: true false	false
SystemDiskKMSKeyId	string	The ID of the KMS key that is applied to the system disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
SystemDiskEncryptAlgorithm	string	The encryption algorithm that is applied to the system disk. Valid values: AES-256 SM4-128	AES-256
SystemDiskProvisionedIops	long	The provisioned IOPS of the system disk. Note IOPS measures the number of read and write operations that an EBS device can process per second.	100
SystemDiskBurstingEnabled	boolean	Indicates whether the Performance Burst feature is enabled for the system disk. Valid values: true false Note This parameter is available only when you set SystemDisk.Category to cloud_auto.	false
ImageOptionsLoginAsNonRoot	boolean	Indicates whether the ecs-user username can be used to log on to an ECS instance created from the scaling configuration. Valid values: true false	false
DeletionProtection	boolean	Indicates whether Release Protection is enabled for the ECS instances. You can specify this parameter to determine whether the ECS instances can be deleted by using the ECS console or calling the DeleteInstance operation. Valid values: true: Release Protection is enabled for the ECS instances. You cannot delete the ECS instances by using the ECS console or calling the DeleteInstance operation. false: Release Protection is disabled for the ECS instances. You can delete the ECS instances by using the ECS console or calling the DeleteInstance operation. Note You can enable Release Protection for only pay-as-you-go instances to prevent unexpected instance deletion during scale-in events. The Release Protection feature does not affect normal scaling activities. In other words, an instance that meets the criteria of scale-in policies may be removed from a scaling group during a scale-in event even if you enabled Release Protection for the instance.	false
StorageSetId	string	The ID of the storage set.	ss-bp67acfmxazb4p****
StorageSetPartitionNumber	integer	The maximum number of partitions in the storage set. The value is an integer that is greater than or equal to 2.	2
NetworkInterfaces	array<object>	The ENIs.
NetworkInterface	object
InstanceType	string	The ENI type. Valid values: Primary: the primary ENI Secondary: the secondary ENI	Primary
NetworkInterfaceTrafficMode	string	The communication mode of the ENI. Valid values: Standard: The TCP communication mode is used. HighPerformance: The Elastic RDMA Interface (ERI) is enabled and the remote direct memory access (RDMA) communication mode is used.	HighPerformance
Ipv6AddressCount	integer	The number of randomly generated IPv6 addresses that are allocated to the primary ENI.	1
SecurityGroupIds	array	The IDs of the security groups to which the ENIs belong.
SecurityGroupId	string	The ID of the security group to which the ENI belongs.	sg-2vc3e1v7xxxxx
DedicatedHostClusterId	string	The ID of the dedicated host cluster.	dc-zm04u8r3lohsq****
PasswordSetted	boolean	Indicates whether a password is configured for the instance.	false
HttpEndpoint	string	Indicates whether the access channel is enabled for instance metadata. Valid values: enabled disabled	enabled
HttpTokens	string	Indicates whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values: optional: The security hardening mode IMDSv2 is not forcibly used. required: The security hardening mode (IMDSv2) is forcibly used. After you set this parameter to required, you cannot access instance metadata in normal mode.	optional

Examples

Sample success responses

JSONformat

{
  "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": 0,
      "InternetMaxBandwidthIn": 200,
      "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"
          ]
        }
      ],
      "DedicatedHostClusterId": "dc-zm04u8r3lohsq****",
      "PasswordSetted": false,
      "SecurityOptions": {
        "ConfidentialComputingMode": "TDX"
      },
      "HttpEndpoint": "enabled",
      "HttpTokens": "optional"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-08	The response structure of the API has changed	View Change Details
2024-10-10	The response structure of the API has changed	View Change Details
2024-06-12	The response structure of the API has changed	View Change Details
2024-04-23	The response structure of the API has changed	View Change Details
2024-03-20	The response structure of the API has changed	View Change Details
2024-01-29	The response structure of the API has changed	View Change Details
2023-11-24	The response structure of the API has changed	View Change Details
2023-08-23	The response structure of the API has changed	View Change Details
2023-04-12	The response structure of the API has changed	View Change Details