You can call this operation to query 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 No 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 a scaling configuration belongs.

PageNumber Integer No 1

The number of the page to return. Starting value: 1.

Default value: 1

PageSize Integer No 50

The number of entries to return on each 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.1 String No asc-bp17pelvl720x5ub****

The ID of scaling configuration N to be queried. Valid values of N: 1 to 10. The IDs of active and inactive scaling configurations are displayed in the query result, and can be differentiated by LifecycleState.

ScalingConfigurationName.1 String No c1908dd1-690f-4c9b-ab73-350f1f06****

The name of scaling configuration N to be queried. Valid values of N: 1 to 10. The names of inactive scaling configurations are not displayed in the query result and no errors are reported.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of scaling configurations.

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

The collection of scaling configurations.

ScalingConfigurationId String asc-bp1ezrfgoyn5kijl****

The ID of the scaling configuration.

ScalingConfigurationName String c1908dd1-690f-4c9b-ab73-350f1f06****

The name of the scaling configuration.

ScalingGroupId String sg-280ih****

The ID of the scaling group to which the scaling configuration belongs.

Instance name String fortest

The name of the ECS instance.

ImageId String centos6u5_64_20G_aliaegis_20140703.vhd

The ID of the image file used to automatically create an instance.

ImageName String centos6u5_64_20G_aliaegis_20140703.vhd

The name of the image file.

HostName String LocalHost

The hostname of the ECS instance.

InstanceType String ecs.t1.xsmall

The type of the ECS instance.

Cpu Integer 2

The number of vCPUs.

You can specify the number of vCPUs and the amount of memory to define the range of instance types. For example, to specify instance types that have 2 vCPUs and 16 GiB memory, set the value of Cpu to 2 and the value of Memory to 16. Auto Scaling uses the properties of instances such as its storage I/O performance and zone to determine a collection of available instances types. Auto Scaling then creates instances of the type that is the most cost-effective out of the available types.

Note This instance type range takes effect only when cost optimization is enabled and the scaling configuration does not have a specified instance type.
Memory Integer 16

The amount of memory.

You can specify the number of vCPUs and the amount of memory to define the range of instance types. For example, to specify instance types that have 2 vCPUs and 16 GiB memory, set the value of Cpu to 2 and the value of Memory to 16. Auto Scaling uses the properties of instances such as its storage I/O performance and zone to determine a collection of available instances types. Auto Scaling then creates instances of the type that is the most cost-effective out of the available types.

Note This instance type range takes effect only when cost optimization is enabled and the scaling configuration does not have a specified instance type.
InstanceGeneration String ecs-3

The generation of the ECS instance.

SecurityGroupId String sg-bp18kz60mefs****

The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other.

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.
InternetChargeType String PayByTraffic

The billing method of the network bandwidth. Valid values:

  • PayByBandwidth: You must pay for the maximum available bandwidth specified by the InternetMaxBandwidthOut parameter.
  • PayByTraffic: You pay for the actual traffic used. The InternetMaxBandwidthOut parameter only specifies the upper limit of available bandwidth when this parameter is specified.
InternetMaxBandwidthIn Integer 200

The maximum inbound bandwidth from the Internet. Unit: Mbit/s. Valid values: 1 to 200.

InternetMaxBandwidthOut Integer 0

The maximum outbound bandwidth to the Internet. Unit: Mbit/s. Valid values: 0 to 100.

  • If InternetChargeType is set to PayByBandwidth and this parameter is not specified, this parameter is automatically set to 0.
  • If InternetChargeType is set to PayByTraffic and this parameter is not specified, an error is returned.
SystemDiskCategory String cloud

The type of the system disk. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • ephemeral_ssd: local SSD
  • cloud_essd: enhanced SSD
SystemDiskSize Integer 100

The size of the system disk.

SystemDiskName String cloud_ssdSystem

The name of the system disk.

SystemDiskDescription String FinanceDept

The description of the system disk.

SystemDiskAutoSnapshotPolicyId String sp-bp12m37ccmxvbmi5****

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

LifecycleState String Active

The state of the scaling configuration in a scaling group. Valid values:

  • Active: The scaling configuration is active in a scaling group. Active scaling configurations are used by a scaling group to automatically create ECS instances.
  • Inactive: Inactive scaling configurations are still retained in a scaling group, but are not used by the group to create ECS instances.
CreationTime String 2014-08-14T10:58Z

The time when a scaling configuration was created.

LoadBalancerWeight Integer 1

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

UserData String echo hello ecs!

The user data of the ECS instance.

KeyPairName String fortest

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

RamRoleName String RamRoleTest

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

DeploymentSetId String ds-bp1frxuzdg87zh4p****

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

SecurityEnhancementStrategy String Active

Indicates whether the security hardening is enabled. Valid values:

  • Active: enables security hardening for public images.
  • Deactive: disables security hardening for all image types.
SpotStrategy String NoSpot

The preemption policy to be applied to pay-as-you-go instances. Valid values:

  • NoSpot: the pay-as-you-go instance.
  • SpotWithPriceLimit: the preemptible instance with a maximum hourly price.
  • SpotAsPriceGo: the preemptible instance whose price is based on the current market price.
PasswordInherit Boolean true

Indicates whether the password predefined in the specified image is used.

ResourceGroupId String rg-resourcegroupid1

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

HpcClusterId String hpc-clusterid

The ID of the E-HPC cluster to which the ECS instance belongs.

InstanceDescription String FinaceDept

The description of the ECS instance.

Ipv6AddressCount Integer 1

The number of randomly generated IPv6 addresses for the ENI.

DataDisks Array

The collection of data disk details.

Size Integer 200

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

  • cloud: 5 to 2000
  • cloud_efficiency: 20 to 32768
  • cloud_ssd: 20 to 32768
  • cloud_essd: 20 to 32768
  • ephemeral_ssd: 5 to 800
Category String cloud

The disk type of the data disk. Valid values:

  • cloud: basic disk. The DeleteWithInstance attribute of a basic disk created together with the instance is true.
  • cloud_efficiency: ultra disks.
  • cloud_ssd: standard SSD.
  • ephemeral_ssd: local SSD.
  • cloud_essd: enhanced SSD.
SnapshotId String s-23f2i****

The ID of the snapshot used to create data disks.

Device String /dev/xvdb

The mount point of the data disk.

DeleteWithInstance Boolean true

Indicates whether the data disk will be released with the instance. Valid values:

  • true: releases the data disk when the instance is released.
  • false: retains the data disk when the attached instance is released.
Encrypted String false

Indicates whether the data disk is encrypted. Valid values:

  • true: The disk is encrypted.
  • false: The disk is not encrypted.
KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

The ID of the KMS key corresponding to the data disk.

DiskName String cloud_ssdData

The name of the data disk.

Description String FinanceDept

The description of the data disk.

AutoSnapshotPolicyId String sp-bp19nq9enxqkomib****

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

Tags Array

The collection of tags.

Key String binary

The key of the tag.

Value String alterTable

The value of the tag.

SpotPriceLimit Array

The collection of preemptible instances.

InstanceType String ecs.t1.xsmall

The type of the preemptible instance.

PriceLimit Float 0.125

The price limit of the preemptible instance.

InstanceTypes List ecs.t1.xsmall

The collection of ECS instance types.

SecurityGroupIds List sg-bp18kz60mefs****

The IDs of the security groups to which an ECS instance belongs. ECS instances in the same security group can access each other.

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_20140703.vhd</ImageId>
                  <InstanceType>ecs.t1.xsmall</InstanceType>
                  <InternetChargeType>PayByTraffic</InternetChargeType>
                  <InternetMaxBandwidthIn>200</InternetMaxBandwidthIn>
                  <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
                  <LifecycleState>Active</LifecycleState>
                  <ScalingConfigurationId>asc-bp1ezrfgoyn5kijl****</ScalingConfigurationId>
                  <ScalingConfigurationName>c1908dd1-690f-4c9b-ab73-350f1f06****</ScalingConfigurationName>
                  <ScalingGroupId>sg-280ih****</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

{
    "RequestId": "804F240A-8D3E-40A1-BD68-6B333DEA2CA8",
    "TotalCount": "1",
    "PageNumber": "1",
    "PageSize": "50",
    "ScalingConfigurations": {
        "ScalingConfiguration": {
            "CreationTime": "2014-08-14T10:58Z",
            "ImageId": "centos6u5_64_20G_aliaegis_20140703.vhd",
            "InstanceType": "ecs.t1.xsmall",
            "InternetChargeType": "PayByTraffic",
            "InternetMaxBandwidthIn": "200",
            "InternetMaxBandwidthOut": "0",
            "LifecycleState": "Active",
            "ScalingConfigurationId": "asc-bp1ezrfgoyn5kijl****",
            "ScalingConfigurationName": "c1908dd1-690f-4c9b-ab73-350f1f06****",
            "ScalingGroupId": "sg-280ih****",
            "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.