Query a scaling configuration

Last Updated: May 11, 2017

Description

This operation queries scaling configuration information. You can query all scaling configurations in a scaling group by specifying the scaling group ID.

Scaling configuration states (LifecycleState) can be set to either of the following:

  • Active: Scaling groups use scaling configurations in the active status to automatically create ECS instances.
  • Inactive: The scaling configuration is inactive in a scaling group. The scaling group will not use scaling configurations in inactive state to automatically create ECS instances.

Request parameters

Name Type Required? Description
Action String Yes Operation interface, required. The parameter value is DescribeScalingConfigurations.
RegionId String Yes Region ID of the scaling group of a scaling configuration.
ScalingGroupId String No Scaling group ID.
ScalingConfigurationId.N String No ID of a scaling configuration. A maximum of 10 values can be entered. Invalid scaling configuration IDs are neglected in the query result and no error is reported.
ScalingConfigurationName.N String No Name of a scaling configuration. A maximum of 10 values can be entered. Invalid scaling configuration names are neglected in the query result and no error is reported.
PageNumber Integer No Page number of the scaling configuration list. The initial value and default value are both 1.
PageSize Integer No When querying by page, this parameter indicates the number of lines per page. Maximum value: 50; default value: 10.

Return parameters

Name Type Description
TotalCount Integer Total number of scaling configurations
PageNumber Integer Current page number
PageSize Integer Number of lines per page
ScalingConfigurations ScalingConfigurationSetType Scaling configuration information set

ScalingConfigurationSetType is a set of ScalingConfigurationItemTypes:

Name Type Description
ScalingConfiguration ScalingConfigurationItemType Scaling configuration information

Attributes of the ScalingConfigurationItemType are listed below:

Name Type Description
ScalingConfigurationId String ID of a scaling configuration
ScalingConfigurationName String Name shown for a scaling configuration
ScalingGroupId String ID of the scaling group of a scaling configuration
ImageId String ID of an image file
InstanceType String Resource rule of an instance
SecurityGroupId String ID of a security group
InternetChargeType String Network billing type
InternetMaxBandwidthIn Integer Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second)
InternetMaxBandwidthOut Integer Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second)
SystemDisk.Category String Category of the system disk
DataDisks DataDiskSetType Data disk information set
LifecycleState String Scaling configuration status in a scaling group
CreationTime String Time when a scaling configuration is created

DataDiskSetType is a set of DataDiskItemTypes:

Name Type Description
DataDisk DataDiskItemType Data disk information

Attributes of the DataDiskItemType are listed below:

Name Type Description
Size Integer Disk capacity
Category String Disk category
SnapshotId String ID of the snapshot used for creating the data disk
Device String Data disk attaching point

Error code

For errors common to all interfaces, refer to the Client Error Table or Server Error Table.

Example

Request example
  1. http://ess.aliyuncs.com/?Action=CreateScalingConfiguration
  2. &RegionId=cn-qingdao
  3. &PageSize=50
  4. &<Public Request Parameters>
Return example

XML format:

  1. <DescribeScalingConfigurationsResponse>
  2. <RequestId>804F240A-8D3E-40A1-BD68-6B333DEA2CA8</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>50</PageSize>
  6. <ScalingConfigurations>
  7. <ScalingConfiguration>
  8. <CreationTime>2014-08-14T10:58Z</CreationTime>
  9. <ImageId>centos6u5_64_20G_aliaegis_20140703.vhd</ImageId>
  10. <InstanceType>ecs.t1.xsmall</InstanceType>
  11. <InternetChargeType>PayByBandwidth</InternetChargeType>
  12. <InternetMaxBandwidthIn>200</InternetMaxBandwidthIn>
  13. <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
  14. <LifecycleState>Active</LifecycleState> <ScalingConfigurationId>
  15. bU5uZHcAgtzwcL4IeDeavqTS
  16. </ScalingConfigurationId>
  17. <ScalingConfigurationName>
  18. c1908dd1-690f-4c9b-ab73-350f1f06e84f
  19. </ScalingConfigurationName>
  20. <ScalingGroupId>dE9YbOdCHqaFdFZHXVdDjQCB</ScalingGroupId>
  21. <SecurityGroupId>sg-280ih3w4b</SecurityGroupId>
  22. <SystemDiskCategory>cloud</SystemDiskCategory>
  23. <DataDisks>
  24. <DataDisk>
  25. <Size>200</Size>
  26. <Category>cloud</Category>
  27. <SnapshotId>s-280s7ngih</SnapshotId>
  28. <Device>/dev/xvdb</Device>
  29. </DataDisk>
  30. </DataDisks>
  31. </ScalingConfiguration>
  32. </ScalingConfigurations>
  33. </DescribeScalingConfigurationsResponse>

JSON format:

  1. {
  2. "RequestId": "67E4324F-CE14-4C2C-9D60-5422641DB76F",
  3. "TotalCount": 1,
  4. "PageNumber": 1,
  5. "PageSize": 1,
  6. "ScalingConfigurations": {
  7. "ScalingConfiguration": [
  8. {
  9. "ScalingConfigurationId": "eqkz17cfW3clcPExOtLNVlD",
  10. "SecurityGroupId": "sg-28oewzxvg",
  11. "CreationTime": "2014-08-18T21:07Z",
  12. "SystemDiskCategory": "cloud",
  13. "InternetMaxBandwidthIn": 200,
  14. "InternetMaxBandwidthOut": 0,
  15. "LifecycleState": "Inactive",
  16. "InternetChargeType": "PayByBandwidth",
  17. "ImageId": "rhel5u7_64_20G_aliaegis_20131231.vhd",
  18. "InstanceType": "ecs.s2.small",
  19. "ScalingConfigurationName": "LxVdcOqPBV",
  20. "ScalingGroupId": "dRsEAGdvbjR5c4SVc2bqLubj",
  21. DataDisks”:{
  22. DataDisk”:[{
  23. Size”:200,
  24. Category”: cloud,
  25. SnapshotId”: s-280s7ngih,
  26. Device”:” /dev/xvdb
  27. }]
  28. }
  29. }
  30. ]
  31. }
  32. }
Thank you! We've received your feedback.