Queries scaling configurations.

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 to which the scaling configuration belongs.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

PageSize Integer No 50

The number of entries to return on each page. Maximum value: 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 RepeatList No asc-bp17pelvl720x5ub****

The ID of scaling configuration N that you want to query. Valid values of N: 1 to 10.

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.

ScalingConfigurationName.N RepeatList No scalingcon****

The name of scaling configuration N that you want to query. Valid values of N: 1 to 10.

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

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 50

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

ScalingConfigurations Array of ScalingConfiguration

Information about the scaling configurations.

ScalingConfiguration
Affinity String default

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

  • default: The instance is not associated with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
  • host: The instance is associated with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the original dedicated host has insufficient resources, the instance cannot be started.
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 the Cpu and Memory parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.

Note This instance type range is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
CreationTime String 2014-08-14T10:58Z

The time when the scaling configuration was created.

CreditSpecification String Standard

The performance mode of the burstable instance. Valid values:

  • Standard: the standard mode. For more information, see the "Standard mode" section of the Burstable instances topic.
  • Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section of the Burstable instances topic.
DataDisks Array of DataDisk

Information about the data disks.

DataDisk
AutoSnapshotPolicyId String sp-bp19nq9enxqkomib****

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

Categories List cloud_essd

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 that use the disk category of the highest priority, it creates instances that uses the disk category of the next highest priority. Valid values:

  • cloud: basic disk. The DeleteWithInstance attribute of a basic disk that is created together with the instance is set to true.
  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.
  • cloud_essd: enhanced SSD (ESSD).
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 the instance is set to true.
  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.
  • ephemeral_ssd: local SSD.
  • cloud_essd: ESSD.
DeleteWithInstance Boolean true

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

  • true: The data disk is released when the instance is released.
  • false: The data disk is retained when the instance is released.
Description String FinanceDept

The description of the data disk.

Device String /dev/xvdb

The mount target of the data disk.

DiskName String cloud_ssdData

The name of the data disk.

Encrypted String false

Indicates whether the data disk is encrypted. Valid values:

  • true
  • false

Default value: false.

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

The ID of the Key Management Service (KMS) key used by the data disk.

PerformanceLevel String PL1

The performance level of the data disk that is an ESSD.

Size Integer 200

The size of the data disk. Unit: GiB.

  • Valid values if Category is set to cloud: 5 to 2000.
  • Valid values if Category is set to cloud_efficiency: 20 to 32768.
  • Valid values if Category is set to cloud_ssd: 20 to 32768.
  • Valid values if Category is set to cloud_essd: 20 to 32768.
  • Valid values if Category is set to ephemeral_ssd: 5 to 800.
SnapshotId String s-23f2i****

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

DedicatedHostId String dh-bp67acfmxazb4p****

The ID of the dedicated host on which the Elastic Compute Service (ECS) instance runs. You cannot create preemptible instances on dedicated hosts. If you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit parameters are ignored.

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

DeploymentSetId String ds-bp1frxuzdg87zh4p****

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

HostName String LocalHost

The hostname of the ECS instance.

HpcClusterId String hpc-clus****

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

ImageFamily String hangzhou-daily-update

The name of the image family. If you specify this parameter, the latest custom images that are available in the specified image family are returned. You can use the images to create ECS instances. If you specify the ImageId parameter, you cannot specify the ImageFamily parameter.

ImageId String centos6u5_64_20G_aliaegis_2014****.vhd

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

ImageName String centos6u5_64_20G_aliaegis_20140703.vhd

The name of the image file.

InstanceDescription String FinanceDept

The description of the ECS instance.

InstanceGeneration String ecs-3

The generation of the ECS instance.

InstanceName String instance****

The name of the ECS instance.

InstancePatternInfos Array of InstancePatternInfo

Information about the intelligent configuration settings, which determines the available instance types.

InstancePatternInfo
Cores Integer 2

The number of vCPUs that are supported by the instance type.

InstanceFamilyLevel String EnterpriseLevel

The level of the instance family.

  • EntryLevel: shared instance type. Instances of this level are most cost-effective, but may not always provide stable computing performance. Instances of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see Shared instance families.
  • EnterpriseLevel: Instances of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see Instance family.
  • CreditEntryLevel: This value is available only for burstable instances. CPU credits are used to ensure computing performance. Instances of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see What are burstable instances?
MaxPrice Float 2

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

Memory Float 4

The memory size that is supported by the instance type. Unit: GiB.

InstanceType String ecs.g6.large

The instance type of the ECS instance.

InstanceTypes List ecs.g6.large

The list of ECS instance types.

InternetChargeType String PayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth: You are charged for the maximum available bandwidth that is specified by InternetMaxBandwidthOut.
  • PayByTraffic: You are charged for the actual traffic used. InternetMaxBandwidthOut specifies only the maximum available bandwidth.
InternetMaxBandwidthIn Integer 200

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

InternetMaxBandwidthOut Integer 0

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

  • Valid values if InternetChargeType is set to PayByBandwidth: 0 to 100. If this parameter is not specified, a value of 0 is returned.
  • Valid values if InternetChargeType is set to PayByTraffic: 0 to 100. If this parameter is not specified, an error is reported.
IoOptimized String none

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

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

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

KeyPairName String keypair****

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

LifecycleState String Active

The lifecycle 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. Auto Scaling does not use the inactive scaling configuration to automatically create ECS instances. Inactive scaling configurations are retained in the scaling group.
LoadBalancerWeight Integer 1

The weight of the ECS instance as a backend server. Valid values: 1 to 100.

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 the Cpu and Memory parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances of the instance type that is provided at the lowest price.

Note This instance type range is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
PasswordInherit Boolean true

Indicates whether the password preset in the image is used.

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.

PrivatePoolOptions.MatchCriteria String Open

The type of the private pool. A private pool is generated after an elasticity assurance or a capacity reservation takes effect. You can select a private pool when you create instances. Valid values:

  • Open: open private pool. The system selects a matching open private pool to create instances. If no matching open private pools are available, the resources in the public pool are used.
  • Target: specified private pool. The system uses the capacity of a specified private pool to create instances. If the specified private pool is unavailable, the instances cannot be created.
  • None: no private pool. The capacity of private pools is not used.
RamRoleName String ramrole****

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

ResourceGroupId String rg-aekzn2ou7xo****

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

ScalingConfigurationId String asc-bp1ezrfgoyn5kijl****

The ID of the scaling configuration.

ScalingConfigurationName String scalingconfi****

The name of the scaling configuration.

ScalingGroupId String asg-bp17pelvl720x3v7****

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

SchedulerOptions Struct
Note This parameter is in invitational preview and unavailable for public use.
ManagedPrivateSpaceId String testManagedPrivateSpaceId
Note This parameter is in invitational preview and unavailable for public use.
SecurityEnhancementStrategy String Active

Indicates whether security hardening is enabled. Valid values:

  • Active: Security hardening is enabled. This value is available only for public images.
  • Deactive: Security hardening is disabled. This value is available for all types of images.
SecurityGroupId String sg-bp18kz60mefs****

The ID of the security group with which the ECS instance is associated. The ECS instances that are associated with the same security group can access each other.

SecurityGroupIds List sg-bp18kz60mefs****

The IDs of the security groups with which the ECS instance is associated. The ECS instances that are associated with the same security group can access each other.

SpotDuration Integer 1

The retention period of the preemptible instance. Unit: hours.

SpotInterruptionBehavior String Terminate

The interruption mode of the preemptible instance.

SpotPriceLimit Array of SpotPriceModel

Information about the preemptible instance.

SpotPriceModel
InstanceType String ecs.g6.large

The instance type of the preemptible instance.

PriceLimit Float 0.125

The price limit of the preemptible instance.

SpotStrategy String NoSpot

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

  • NoSpot: The instance is created as a pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.
SystemDisk.EncryptAlgorithm String AES-256

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

  • AES-256
  • SM4-128

Default value: AES-256.

SystemDisk.Encrypted Boolean false

Indicates whether the system disk is encrypted. Valid values:

  • true
  • false

Default value: false.

SystemDisk.KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

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

SystemDiskAutoSnapshotPolicyId String sp-bp12m37ccmxvbmi5****

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

SystemDiskCategories List cloud

The categories of system disks. The values are sorted based on their priorities. The first value has the highest priority. If Auto Scaling cannot create instances that use the disk category of the highest priority, it creates instances that use 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 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: ESSD
SystemDiskDescription String Test system disk.

The description of the system disk.

SystemDiskName String cloud_ssd_Test

The name of the system disk.

SystemDiskPerformanceLevel String PL1

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

SystemDiskSize Integer 100

The size of the system disk.

Tags Array of Tag

Information about tags.

Tag
Key String binary

The tag key of the instance.

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

Value String alterTable

The tag value of the instance.

The tag value 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://.

Tenancy String default

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 the DedicatedHostId parameter, the system selects a dedicated host for the instance that you created.
UserData String echo hello ecs!

The user data of the ECS instance.

WeightedCapacities List 4

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

ZoneId String cn-hangzhou-g

The ID of the zone in which the instance is created. You can call the DescribeZones operation to query the most recent zone list.

TotalCount Integer 1

The total number of scaling configurations.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeScalingConfigurations
&RegionId=cn-qingdao
&<Common request parameters>

Sample success responses

XML format

<DescribeScalingConfigurationsResponse>
      <RequestId>804F240A-8D3E-40A1-BD68-6B333DEA2CA8</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>50</PageSize>
      <ScalingConfigurations>
            <ScalingConfiguration>
                  <CreationTime>2014-08-14T10:58Z</CreationTime>
                  <ImageId>centos6u5_64_20G_aliaegis_2014****.vhd</ImageId>
                  <InstanceType>ecs.g6.large</InstanceType>
                  <InternetChargeType>PayByTraffic</InternetChargeType>
                  <InternetMaxBandwidthIn>200</InternetMaxBandwidthIn>
                  <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
                  <LifecycleState>Active</LifecycleState>
                  <ScalingConfigurationId>asc-bp1ezrfgoyn5kijl****</ScalingConfigurationId>
                  <ScalingConfigurationName>scalingconfig****</ScalingConfigurationName>
                  <ScalingGroupId>asg-bp17pelvl720x3v7****</ScalingGroupId>
                  <SecurityGroupId>sg-bp18kz60mefs****</SecurityGroupId>
                  <SystemDiskCategory>cloud</SystemDiskCategory>
                  <DataDisks>
                        <DataDisk>
                              <Size>200</Size>
                              <Category>cloud</Category>
                              <SnapshotId>s-280s7****</SnapshotId>
                              <Device>/dev/xvdb</Device>
                        </DataDisk>
                  </DataDisks>
            </ScalingConfiguration>
      </ScalingConfigurations>
</DescribeScalingConfigurationsResponse>

JSON format

{
    "DescribeScalingConfigurationsResponse": {
        "RequestId": "804F240A-8D3E-40A1-BD68-6B333DEA2CA8",
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 50,
        "ScalingConfigurations": {
            "ScalingConfiguration": {
                "CreationTime": "2014-08-14T10:58Z",
                "ImageId": "centos6u5_64_20G_aliaegis_2014****.vhd",
                "InstanceType": "ecs.g6.large",
                "InternetChargeType": "PayByTraffic",
                "InternetMaxBandwidthIn": 200,
                "InternetMaxBandwidthOut": 0,
                "LifecycleState": "Active",
                "ScalingConfigurationId": "asc-bp1ezrfgoyn5kijl****",
                "ScalingConfigurationName": "scalingconfig****",
                "ScalingGroupId": "asg-bp17pelvl720x3v7****",
                "SecurityGroupId": "sg-bp18kz60mefs****",
                "SystemDiskCategory": "cloud",
                "DataDisks": {
                    "DataDisk": {
                        "Size": 200,
                        "Category": "cloud",
                        "SnapshotId": "s-280s7****",
                        "Device": "/dev/xvdb"
                    }
                }
            }
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.