All Products
Search
Document Center

Auto Scaling:DescribeScalingConfigurations

更新時間:Dec 18, 2024

Queries scaling configurations of the Elastic Compute Service (ECS) type. When you call the DescribeScalingConfigurations operation, you can specify the scaling group ID and scaling configuration ID to query information such as the name, instance type, and image of a scaling configuration.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DescribeScalingConfigurations

The operation that you want to perform. Set the value to DescribeScalingConfigurations.

RegionId

String

Yes

cn-qingdao

The region ID of the scaling group whose scaling configurations you want to query.

PageNumber

Integer

No

1

The page number. Pages start from page 1.

Default value: 1.

PageSize

Integer

No

50

The number of entries per page. Valid values: 1 to 50.

Default value: 10.

ScalingGroupId

String

No

asg-bp17pelvl720x3v7****

The ID of the scaling group. You can query all scaling configurations in the scaling group.

ScalingConfigurationId.N

String

No

asc-bp17pelvl720x5ub****

The ID of scaling configuration N that you want to query.

The IDs of active and inactive scaling configurations are displayed in the query results. You can identify active and inactive scaling configurations based on the value of LifecycleState.

ScalingConfigurationName.N

String

No

scalingcon****

The name of scaling configuration N that you want to query.

The names of inactive scaling configurations are not displayed in the query results, and no error is returned.

Response parameters

Parameter

Type

Example

Description

RequestId

String

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

The request ID.

PageNumber

Integer

1

The page number.

PageSize

Integer

50

The number of entries per page.

TotalCount

Integer

1

The total number of scaling configurations.

ScalingConfigurations

Array of ScalingConfiguration

The scaling configurations.

ScalingConfiguration

DeploymentSetId

String

ds-bp1frxuzdg87zh4p****

The ID of the deployment set of the ECS instances created from the scaling configuration.

CreationTime

String

2014-08-14T10:58Z

The time when the scaling configuration was created.

ScalingConfigurationName

String

scalingconfigura****

The name of the scaling configuration.

SystemDiskDescription

String

Test system disk.

The description of the system disk.

KeyPairName

String

keypair****

The name of the key pair that is used to log on to an ECS instance created from the scaling configuration.

SecurityGroupId

String

sg-bp18kz60mefs****

The ID of the security group with which the ECS instances created from the scaling configuration are associated. ECS instances that are associated with the same security group can communicate with each other.

PrivatePoolOptions.Id

String

eap-bp67acfmxazb4****

The ID of the private pool. The ID of a private pool is the same as the ID of the elasticity assurance or capacity reservation for which the private pool is generated.

SystemDiskAutoSnapshotPolicyId

String

sp-bp12m37ccmxvbmi5****

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

SpotStrategy

String

NoSpot

The preemption policy that is applied to the pay-as-you-go or preemptible ECS instances. Valid values:

  • NoSpot: The instances are created as regular pay-as-you-go instances.

  • SpotWithPriceLimit: The instances are 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.

ScalingGroupId

String

asg-bp17pelvl720x3v7****

The ID of the scaling group in which the scaling configuration was created.

Affinity

String

default

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

  • default: The ECS instance is not associated with the dedicated host. If you restart an instance in Economical Mode and the original dedicated host has insufficient resources, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool.

  • host: The ECS instance is associated with the dedicated host. If you restart an instance in Economical Mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the restart operation fails.

Tenancy

String

default

Indicates whether the ECS instances are created on dedicated hosts. Valid values:

  • default: The ECS instances are created on non-dedicated hosts.

  • host: The ECS instances are created on dedicated hosts. If you do not specify DedicatedHostId, Alibaba Cloud selects dedicated hosts to create ECS instances.

SystemDiskSize

Integer

100

The size of the system disk. Unit: GiB.

Ipv6AddressCount

Integer

1

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

SpotDuration

Integer

1

The retention period of the preemptible ECS instances. Unit: hours.

LifecycleState

String

Active

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 active scaling configuration to automatically create ECS instances.

  • Inactive: The scaling configuration is inactive in the scaling group. Inactive scaling configurations are retained in the scaling group. Auto Scaling does not use inactive scaling configurations to create ECS instances.

InstanceName

String

instance****

The name series of the ECS instances created from the scaling configuration.

SecurityEnhancementStrategy

String

Active

Indicates whether the Security Hardening feature is enabled. Valid values:

  • Active: The Security Hardening feature is enabled. This value applies only to public images.

  • Deactive: The Security Hardening feature is disabled. This value applies to all types of images.

UserData

String

echo hello ecs!

The user data of the ECS instances. The data is encoded in Base64.

PrivatePoolOptions.MatchCriteria

String

Open

The type of the private pool that is used to start ECS instances. 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 ECS instances. Valid values:

  • Open: an open private pool. Auto Scaling selects a matching open private pool to start ECS instances. If no matching open private pools exist, Auto Scaling uses the resources in the public pool to start ECS instances.

  • Target: the specified private pool. Auto Scaling uses the resources in the specified private pool to start ECS instances. If the resources in the specified private pool are insufficient, ECS instances cannot be started.

  • None: no private pool. Auto Scaling does not use the resources in private pools to start ECS instances.

DedicatedHostId

String

dh-bp67acfmxazb4p****

The IDs of the dedicated hosts on which the ECS instances are created. Preemptible instances cannot be created on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are ignored.

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

InstanceGeneration

String

ecs-3

The generation of the ECS instances created from the scaling configuration.

HpcClusterId

String

hpc-clus****

The ID of the Elastic High Performance Computing (E-HPC) cluster to which the ECS instances belong.

PasswordInherit

Boolean

true

Indicates whether the password that is preconfigured in the image is used.

Memory

Integer

16

The memory size. Unit: GiB.

You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type.

Note

You can specify Cpu and Memory to define the range of instance types only if you set Scaling Policy to Cost Optimization Policy and do not specify an instance type in the scaling configuration.

ImageId

String

centos6u5_64_20G_aliaegis_2014****.vhd

The ID of the image that is used by Auto Scaling to automatically create ECS instances.

ImageFamily

String

hangzhou-daily-update

The name of the image family. You can specify the ImageFamily request parameter to obtain the most recent available images in the current image family for instance creation. If you specify ImageId, you cannot specify ImageFamily.

ImageOwnerAlias

String

system

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.

LoadBalancerWeight

Integer

1

The load balancing weight of each ECS instance when they are used as backend servers. Valid values: 1 to 100.

SystemDiskCategory

String

cloud

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

HostName

String

LocalHost

The hostname series of the ECS instances created from the scaling configuration.

SystemDiskName

String

cloud_ssd_Test

The name of the system disk.

InternetMaxBandwidthOut

Integer

10

The maximum outbound public bandwidth. Unit: Mbit/s.

InternetMaxBandwidthIn

Integer

10

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

InstanceType

String

ecs.g6.large

The instance type of the ECS instances.

InstanceDescription

String

FinanceDept

The description of the ECS instances.

IoOptimized

String

none

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.

RamRoleName

String

ramrole****

The name of the Resource Access Management (RAM) role that is attached to the ECS instances. The name is provided and maintained by RAM. You can call the ListRoles operation to query the available RAM roles. You can call the CreateRole operation to create RAM roles.

SystemDiskPerformanceLevel

String

PL1

The performance level (PL) of the system disk that is an ESSD.

Cpu

Integer

2

The number of vCPUs.

You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type.

Note

You can specify Cpu and Memory to define the range of instance types only if you set Scaling Policy to Cost Optimization Policy and do not specify an instance type in the scaling configuration.

ResourceGroupId

String

rg-aekzn2ou7xo****

The ID of the resource group to which the ECS instances belong.

ZoneId

String

cn-hangzhou-g

The zone ID of the ECS instances. You can call the DescribeZones operation to query the most recent zone list.

InternetChargeType

String

PayByTraffic

The metering method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth. You are charged for the maximum available bandwidth that is specified by InternetMaxBandwidthOut.

  • PayByTraffic: pay-by-traffic. You are charged based on the actual amount of transferred data. InternetMaxBandwidthOut specifies only the maximum available bandwidth.

ImageName

String

centos6u5_64_20G_aliaegis_20140703.vhd

The name of the image.

ScalingConfigurationId

String

asc-bp1ezrfgoyn5kijl****

The ID of the scaling configuration.

CreditSpecification

String

Standard

The performance mode of the burstable instances. Valid values:

SpotInterruptionBehavior

String

Terminate

The interruption mode of the preemptible instances.

DataDisks

Array of DataDisk

The data disks.

DataDisk

PerformanceLevel

String

PL1

The PL of the data disk that is an ESSD.

Description

String

FinanceDept

The description of the data disk.

SnapshotId

String

s-23f2i****

The ID of the snapshot that is used to create the data disk.

Device

String

/dev/xvdb

The mount target of the data disk.

Size

Integer

200

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

  • 5 to 2000 if you set DataDisk.Category to cloud.

  • 20 to 32768 if you set DataDisk.Category to cloud_efficiency.

  • 20 to 32768 if you set DataDisk.Category to cloud_ssd.

  • 20 to 32768 if you set DataDisk.Category to cloud_essd.

  • 5 to 800 if you set DataDisk.Category to ephemeral_ssd.

DiskName

String

cloud_ssdData

The name of the data disk.

AutoSnapshotPolicyId

String

sp-bp19nq9enxqkomib****

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

Category

String

cloud

The category of the data disk. Valid values:

  • cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with an 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 disk.

KMSKeyId

String

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

The ID of the Key Management Service (KMS) key that is used to encrypt the data disk.

DeleteWithInstance

Boolean

true

Indicates whether the data disk is released when the ECS instance to which the data disk is attached is released. Valid values:

  • true

  • false

Encrypted

String

false

Indicates whether the data disk is encrypted. Valid values:

  • true

  • false

Categories

Array of String

cloud_essd

The categories of the data disks. The categories are arranged in descending order of priority. If Auto Scaling cannot create disks by using the disk category that has the highest priority, Auto Scaling creates disks by using the disk category that has the next highest priority. Valid values:

  • cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with an ECS instance is set to true.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

ProvisionedIops

Long

100

The provisioned IOPS of the data disk.

Note

IOPS refers to the number of read and write operations that an Elastic Block Storage (EBS) device can process per second.

BurstingEnabled

Boolean

false

Indicates whether the Burst feature is enabled for the data disk. Valid values:

  • true

  • false

Note

This parameter is available only if you set DataDisk.Category to cloud_auto.

Tags

Array of Tag

The tags.

Tag

Key

String

binary

The key of tag N. Valid values of N: 1 to 20.

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

Value

String

alterTable

The value of tag N. Valid values of N: 1 to 20.

The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:.

SpotPriceLimit

Array of SpotPriceModel

The preemptible instances.

SpotPriceModel

InstanceType

String

ecs.g6.large

The instance type of the preemptible instances.

PriceLimit

Float

0.125

The price limit of the preemptible instances.

InstancePatternInfos

Array of InstancePatternInfo

The intelligent configurations, which determine the range of available instance types.

InstancePatternInfo

MaxPrice

Float

2

The maximum hourly price of the pay-as-you-go or preemptible instances.

Cores

Integer

2

The number of vCPUs per instance type.

Memory

Float

4

The memory size per instance type. Unit: GiB.

InstanceFamilyLevel

String

EnterpriseLevel

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 ensure consistent computing performance. Instance types of this level are suitable for business 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 business 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.

Architectures

Array of String

X86

The architecture types of the instance types. Valid values:

  • X86: x86.

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

  • BareMetal: ECS Bare Metal Instance.

  • Arm: Arm.

By default, all values are selected.

BurstablePerformance

String

Include

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.

Default value: Include.

ExcludedInstanceTypes

Array of String

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

The instance types that are excluded. You can use an asterisk (*) as the wildcard character 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.

InstanceTypeFamilies

Array of String

ecs.g6

Instance family N that is queried. Valid values of N: 1 to 10.

MinimumCpuCoreCount

Integer

2

The minimum number of vCPUs per instance type.

MaximumCpuCoreCount

Integer

4

The maximum number of vCPUs per instance type.

Note

The value of MaximumCpuCoreCount cannot exceed four times the value of MinimumCpuCoreCount.

GpuSpecs

Array of String

NVIDIA V100

The GPU model.

InstanceCategories

Array of String

Compute-optimized with GPU

Category N of the instances type. Valid values:

Note

Valid values of N: 1 to 10.

  • 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 that uses local SSDs.

  • High Clock Speed: instance type that has a high clock speed.

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

CpuArchitectures

Array of String

X86

CPU architecture N of the instance types. Valid values:

Note

Valid values of N: 1 and 2.

  • x86

  • Arm

PhysicalProcessorModels

Array of String

Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY

Processor model N of the ECS instances. Valid values of N: 1 to 10.

MinimumEniQuantity

Integer

2

The minimum number of ENIs per instance.

MinimumEniPrivateIpAddressQuantity

Integer

2

The minimum number of IPv4 addresses per ENI.

MinimumEniIpv6AddressQuantity

Integer

1

The minimum number of IPv6 addresses per ENI.

MinimumInitialCredit

Integer

12

The initial vCPU credits of each t5 or t6 burstable instance.

MinimumBaselineCredit

Integer

12

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

MinimumMemorySize

Float

4

The minimum memory size per instance. Unit: GiB.

MaximumMemorySize

Float

4

The maximum memory size per instance. Unit: GiB.

MinimumGpuAmount

Integer

2

The minimum number of GPUs per instance. The value is a positive integer.

MaximumGpuAmount

Integer

2

The maximum number of GPUs per instance. The value is a positive integer.

SystemDiskCategories

Array of String

cloud

The categories of the system disks. The categories are arranged in descending order of priority. If Auto Scaling cannot create disks by using the disk category that has the highest priority, Auto Scaling creates disks by using the disk category that has the next highest priority. Valid values:

  • cloud: basic disk.

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

WeightedCapacities

Array of String

4

The weight of the instance type. The value of this parameter indicates the capacity of an instance of the instance type in the scaling group. A higher weight indicates that a smaller number of instances of this instance type are required to achieve the expected capacity.

InstanceTypes

Array of String

ecs.g6.large

The ECS instance types.

SecurityGroupIds

Array of String

sg-bp18kz60mefs****

The IDs of the security groups with which the ECS instances created from the scaling configuration are associated. ECS instances that are associated with the same security group can communicate with each other.

SchedulerOptions

Object

The scheduler option.

ManagedPrivateSpaceId

String

testManagedPrivateSpaceId

The smart hosting pool.

SystemDisk.Encrypted

Boolean

false

Indicates whether the system disk is encrypted. Valid values:

  • true

  • false

SystemDisk.KMSKeyId

String

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

The ID of the KMS key that is used to encrypt the system disk.

SystemDisk.EncryptAlgorithm

String

AES-256

The algorithm that is used to encrypt the system disk. Valid values:

  • AES-256

  • SM4-128

SystemDisk.ProvisionedIops

Long

100

The provisioned IOPS of the system disk.

Note

IOPS refers to the number of read and write operations that an EBS device can process per second.

SystemDisk.BurstingEnabled

Boolean

false

Indicates whether the Burst feature is enabled for the system disk. Valid values:

  • true

  • false

Note

This parameter is available only if you set SystemDisk.Category to cloud_auto.

ImageOptions.LoginAsNonRoot

Boolean

false

Indicates whether the ecs-user username can be used to log on to the ECS instances. Valid values:

  • true

  • false

DeletionProtection

Boolean

false

Indicates whether the Release Protection feature is enabled for the ECS instances created from the scaling configuration. This parameter applies only to pay-as-you-go instances. You can use this parameter to specify whether to directly release ECS instances in the ECS console or by calling the DeleteInstance operation. Valid values:

  • true: The Release Protection feature is enabled. You cannot release ECS instances in the ECS console or by calling the DeleteInstance operation. This prevents unexpected instance deletion.

  • false: The Release Protection feature is disabled. You can release ECS instances in the ECS console or by calling the DeleteInstance operation.

Note

The Release Protection feature does not affect normal scale-in operations. If you enable the Release Protection feature for an ECS instance and the ECS instance meets the requirements defined in the scale-in policy, the ECS instance may still be released during a scale-in event.

StorageSetId

String

ss-bp67acfmxazb4p****

The ID of the storage set.

StorageSetPartitionNumber

Integer

2

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

CustomPriorities

Array of CustomPriority

The priority of the custom ECS instance type + vSwitch combination.

Note

This parameter takes effect only if you set Scaling Policy to Priority Policy.

If Auto Scaling cannot create ECS instances by using the ECS instance type + vSwitch combination that has the highest priority, Auto Scaling automatically creates ECS instances by using the ECS instance type + vSwitch combination that has the next highest priority.

Note

If you specify priorities only for specific ECS instance type + vSwitch combinations, Auto Scaling preferentially uses the combinations that have specified priorities. If the combinations that have specified priorities do not provide sufficient resources, Auto Scaling uses the combinations that do not have specified priorities based on the specified orders of vSwitches and instance types. Example: The specified order of vSwitches of the scaling group is vsw1 and vsw2, and the specified order of instance types in the 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

InstanceType

String

ecs.g6.large

The ECS instance type.

Note

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

VswitchId

String

vsw-bp14zolna43z266bq****

The ID of the vSwitch.

Note

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

NetworkInterfaces

Array of NetworkInterface

The ENIs.

NetworkInterface

InstanceType

String

Primary

The type of the ENI. Valid values:

  • Primary: the primary ENI.

  • Secondary: the secondary ENI.

NetworkInterfaceTrafficMode

String

HighPerformance

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.

Ipv6AddressCount

Integer

1

The number of randomly generated IPv6 addresses that are allocated to the primary ENI.

SecurityGroupIds

Array of String

sg-2vc3e1v7h****

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

DedicatedHostClusterId

String

dc-2zedxc67zqzt7lb4****

The ID of the dedicated host cluster.

PasswordSetted

Boolean

false

Indicates whether passwords are specified for the ECS instances created from the scaling configuration. Valid values:

  • true

  • false

SecurityOptions

Object

The security option.

ConfidentialComputingMode

String

TDX

The confidential computing mode. Valid values:

HttpEndpoint

String

enabled

Indicates whether the access channel is enabled for instance metadata. Valid values:

  • enabled

  • disabled

HttpTokens

String

optional

Indicates whether the security hardening mode IMDSv2 is forcibly 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. If you set this parameter to required, you cannot access instance metadata in normal mode.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeScalingConfigurations
&RegionId=cn-qingdao
&PageNumber=1
&PageSize=50
&ScalingGroupId=asg-bp17pelvl720x3v7****
&ScalingConfigurationId=["asc-bp17pelvl720x5ub****"]
&ScalingConfigurationName=["scalingcon****"]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeScalingConfigurationsResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <TotalCount>1</TotalCount>
    <ScalingConfigurations>
        <DeploymentSetId>ds-bp1frxuzdg87zh4p****</DeploymentSetId>
        <CreationTime>2014-08-14T10:58Z</CreationTime>
        <ScalingConfigurationName>scalingconfigura****</ScalingConfigurationName>
        <SystemDiskDescription>Test system disk.</SystemDiskDescription>
        <KeyPairName>keypair****</KeyPairName>
        <SecurityGroupId>sg-bp18kz60mefs****</SecurityGroupId>
        <PrivatePoolOptions.Id>eap-bp67acfmxazb4****</PrivatePoolOptions.Id>
        <SystemDiskAutoSnapshotPolicyId>sp-bp12m37ccmxvbmi5****</SystemDiskAutoSnapshotPolicyId>
        <SpotStrategy>NoSpot</SpotStrategy>
        <ScalingGroupId>asg-bp17pelvl720x3v7****</ScalingGroupId>
        <Affinity>default</Affinity>
        <Tenancy>default</Tenancy>
        <SystemDiskSize>100</SystemDiskSize>
        <Ipv6AddressCount>1</Ipv6AddressCount>
        <SpotDuration>1</SpotDuration>
        <LifecycleState>Active</LifecycleState>
        <InstanceName>instance****</InstanceName>
        <SecurityEnhancementStrategy>Active</SecurityEnhancementStrategy>
        <UserData>echo hello ecs!</UserData>
        <PrivatePoolOptions.MatchCriteria>Open</PrivatePoolOptions.MatchCriteria>
        <DedicatedHostId>dh-bp67acfmxazb4p****</DedicatedHostId>
        <InstanceGeneration>ecs-3</InstanceGeneration>
        <HpcClusterId>hpc-clus****</HpcClusterId>
        <PasswordInherit>true</PasswordInherit>
        <Memory>16</Memory>
        <ImageId>centos6u5_64_20G_aliaegis_2014****.vhd</ImageId>
        <ImageFamily>hangzhou-daily-update</ImageFamily>
        <ImageOwnerAlias>system</ImageOwnerAlias>
        <LoadBalancerWeight>1</LoadBalancerWeight>
        <SystemDiskCategory>cloud</SystemDiskCategory>
        <HostName>LocalHost</HostName>
        <SystemDiskName>cloud_ssd_Test</SystemDiskName>
        <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
        <InternetMaxBandwidthIn>200</InternetMaxBandwidthIn>
        <InstanceType>ecs.g6.large</InstanceType>
        <InstanceDescription>FinanceDept</InstanceDescription>
        <IoOptimized>none</IoOptimized>
        <RamRoleName>ramrole****</RamRoleName>
        <SystemDiskPerformanceLevel>PL1</SystemDiskPerformanceLevel>
        <Cpu>2</Cpu>
        <ResourceGroupId>rg-aekzn2ou7xo****</ResourceGroupId>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <InternetChargeType>PayByTraffic</InternetChargeType>
        <ImageName>centos6u5_64_20G_aliaegis_20140703.vhd</ImageName>
        <ScalingConfigurationId>asc-bp1ezrfgoyn5kijl****</ScalingConfigurationId>
        <CreditSpecification>Standard</CreditSpecification>
        <SpotInterruptionBehavior>Terminate</SpotInterruptionBehavior>
        <DataDisks>
            <PerformanceLevel>PL1</PerformanceLevel>
            <Description>FinanceDept</Description>
            <SnapshotId>s-23f2i****</SnapshotId>
            <Device>/dev/xvdb</Device>
            <Size>200</Size>
            <DiskName>cloud_ssdData</DiskName>
            <AutoSnapshotPolicyId>sp-bp19nq9enxqkomib****</AutoSnapshotPolicyId>
            <Category>cloud</Category>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
            <DeleteWithInstance>true</DeleteWithInstance>
            <Encrypted>false</Encrypted>
            <Categories>cloud_essd</Categories>
            <ProvisionedIops>100</ProvisionedIops>
            <BurstingEnabled>false</BurstingEnabled>
        </DataDisks>
        <Tags>
            <Key>binary</Key>
            <Value>alterTable</Value>
        </Tags>
        <SpotPriceLimit>
            <InstanceType>ecs.g6.large</InstanceType>
            <PriceLimit>0.125</PriceLimit>
        </SpotPriceLimit>
        <InstancePatternInfos>
            <MaxPrice>2</MaxPrice>
            <Cores>2</Cores>
            <Memory>4</Memory>
            <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>
            <Architectures>X86</Architectures>
            <BurstablePerformance>Include</BurstablePerformance>
            <ExcludedInstanceTypes>ecs.n1.small/ecs.n1.*/*7*</ExcludedInstanceTypes>
            <InstanceTypeFamilies>["ecs.g6", "ecs.c6", … "ecs.r6"]</InstanceTypeFamilies>
            <MinimumCpuCoreCount>2</MinimumCpuCoreCount>
            <MaximumCpuCoreCount>4</MaximumCpuCoreCount>
            <GpuSpecs>["NVIDIA V100"]</GpuSpecs>
            <InstanceCategories>["Compute-optimized with GPU"]</InstanceCategories>
            <CpuArchitectures>["X86", "ARM"]</CpuArchitectures>
            <PhysicalProcessorModels>["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"]</PhysicalProcessorModels>
            <MinimumEniQuantity>2</MinimumEniQuantity>
            <MinimumEniPrivateIpAddressQuantity>2</MinimumEniPrivateIpAddressQuantity>
            <MinimumEniIpv6AddressQuantity>1</MinimumEniIpv6AddressQuantity>
            <MinimumInitialCredit>12</MinimumInitialCredit>
            <MinimumBaselineCredit>12</MinimumBaselineCredit>
            <MinimumMemorySize>4</MinimumMemorySize>
            <MaximumMemorySize>4</MaximumMemorySize>
            <MinimumGpuAmount>2</MinimumGpuAmount>
            <MaximumGpuAmount>2</MaximumGpuAmount>
        </InstancePatternInfos>
        <SystemDiskCategories>cloud</SystemDiskCategories>
        <WeightedCapacities>4</WeightedCapacities>
        <InstanceTypes>ecs.g6.large</InstanceTypes>
        <SecurityGroupIds>sg-bp18kz60mefs****</SecurityGroupIds>
        <SchedulerOptions>
            <ManagedPrivateSpaceId>testManagedPrivateSpaceId</ManagedPrivateSpaceId>
        </SchedulerOptions>
        <SystemDisk.Encrypted>false</SystemDisk.Encrypted>
        <SystemDisk.KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</SystemDisk.KMSKeyId>
        <SystemDisk.EncryptAlgorithm>AES-256</SystemDisk.EncryptAlgorithm>
        <SystemDisk.ProvisionedIops>100</SystemDisk.ProvisionedIops>
        <SystemDisk.BurstingEnabled>false</SystemDisk.BurstingEnabled>
        <ImageOptions.LoginAsNonRoot>false</ImageOptions.LoginAsNonRoot>
        <DeletionProtection>false</DeletionProtection>
        <StorageSetId>ss-bp67acfmxazb4p****</StorageSetId>
        <StorageSetPartitionNumber>2</StorageSetPartitionNumber>
        <CustomPriorities>
            <InstanceType>ecs.g6.large</InstanceType>
            <VswitchId>vsw-bp14zolna43z266bq****</VswitchId>
        </CustomPriorities>
        <NetworkInterfaces>
            <InstanceType>Primary</InstanceType>
            <NetworkInterfaceTrafficMode>HighPerformance</NetworkInterfaceTrafficMode>
            <Ipv6AddressCount>1</Ipv6AddressCount>
            <SecurityGroupIds>sg-2vc3e1v7h****</SecurityGroupIds>
        </NetworkInterfaces>
        <DedicatedHostClusterId>dc-2zedxc67zqzt7lb4****</DedicatedHostClusterId>
    </ScalingConfigurations>
</DescribeScalingConfigurationsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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!",
    "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_20140703.vhd",
    "ScalingConfigurationId" : "asc-bp1ezrfgoyn5kijl****",
    "CreditSpecification" : "Standard",
    "SpotInterruptionBehavior" : "Terminate",
    "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"
    } ],
    "SpotPriceLimit" : [ {
      "InstanceType" : "ecs.g6.large",
      "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\", \"ecs.c6\", … \"ecs.r6\"]" ],
      "MinimumCpuCoreCount" : 2,
      "MaximumCpuCoreCount" : 4,
      "GpuSpecs" : [ "[\"NVIDIA V100\"]" ],
      "InstanceCategories" : [ "[\"Compute-optimized with GPU\"]" ],
      "CpuArchitectures" : [ "[\"X86\", \"ARM\"]" ],
      "PhysicalProcessorModels" : [ "[\"Intel Xeon(Ice Lake) Platinum 8369B\", \"Intel Xeon(Skylake) Platinum 8163\", … \"Intel Xeon(Cascade Lake) Platinum 8269CY\"]" ],
      "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"
    },
    "SystemDisk.Encrypted" : false,
    "SystemDisk.KMSKeyId" : "0e478b7a-4262-4802-b8cb-00d3fb40****",
    "SystemDisk.EncryptAlgorithm" : "AES-256",
    "SystemDisk.ProvisionedIops" : 100,
    "SystemDisk.BurstingEnabled" : false,
    "ImageOptions.LoginAsNonRoot" : false,
    "DeletionProtection" : false,
    "StorageSetId" : "ss-bp67acfmxazb4p****",
    "StorageSetPartitionNumber" : 2,
    "CustomPriorities" : [ {
      "InstanceType" : "ecs.g6.large",
      "VswitchId" : "vsw-bp14zolna43z266bq****"
    } ],
    "NetworkInterfaces" : [ {
      "InstanceType" : "Primary",
      "NetworkInterfaceTrafficMode" : "HighPerformance",
      "Ipv6AddressCount" : 1,
      "SecurityGroupIds" : [ "sg-2vc3e1v7h****" ]
    } ],
    "DedicatedHostClusterId" : "dc-2zedxc67zqzt7lb4****"
  } ]
}

Error codes

For a list of error codes, see Service error codes.