DescribeElasticStrength - Auto Scaling - Alibaba Cloud Documentation Center

Queries the scaling strength of a scaling configuration. The success rate of scale-out events depends on the scaling strength of the scaling configuration that you use. By checking the scaling strength of a scaling configuration, you can assess the performance of Auto Scaling and improve specific 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	DescribeElasticStrength	The operation that you want to perform. Set the value to DescribeElasticStrength.
RegionId	String	Yes	cn-qingdao	The region ID of the scaling group.
ScalingGroupId	String	No	asg-bp18p2yfxow2dloq****	The ID of the scaling group.
InstanceTypes.N	String	No	ecs.g6.large	The instance type of Elastic Compute Service (ECS) instances.
PriorityStrategy	String	No	NoSpot	Note This parameter is deprecated. We recommend that you use SpotStrategy. The preemption policy that you want to apply to pay-as-you-go instances. The preemption policy specified by this parameter overwrites the preemption policy specified in the scaling configuration. Valid values: NoSpot: The ECS instances are created as regular pay-as-you-go instances. SpotWithPriceLimit: The ECS instances are spot instances that have a user-defined maximum hourly price. SpotAsPriceGo: The ECS instances are created as spot instances for which the market price at the time of purchase is automatically used as the bidding price. Default value: NoSpot.
SystemDiskCategories.N	String	No	cloud	Category N of the system disks. Valid values: cloud: the basic disk. cloud_efficiency: the ultra disk. cloud_ssd: the standard SSD. cloud_essd: the Enterprise SSD (ESSD).
ScalingGroupIds.N	String	No	asg-bp14wlu85wrpchm0****	The ID of the scaling group.
SpotStrategy	String	No	NoSpot	The bidding policy of ECS instances. Valid values: NoSpot: The ECS instances are created as pay-as-you-go instances. SpotWithPriceLimit: The ECS instances are created as spot instances for which you can specify the maximum hourly price. SpotAsPriceGo: The ECS instances are created as spot instances for which the market price at the time of purchase is used as the bid price. Default value: NoSpot.
VSwitchIds.N	String	No	vsw-bp1whw2u46cn8zubm****	The ID of vSwitch N. Note If you do not specify the scaling group ID, you must specify this parameter.
ImageId	String	No	centos6u5_64_20G_aliaegis****.vhd	The ID of the image used by Auto Scaling to create ECS instances. Note If you do not specify the scaling group ID, you must specify at least one of ImageId, ImageName, and ImageFamily.
ImageName	String	No	ubuntu_18_04_x64_20G_alibase_20231225.vhd	The name of the image, which must be unique in a region. If you specify ImageId, ImageName is ignored. You cannot use ImageName to specify Alibaba Cloud Marketplace images. Note If you do not specify the scaling group ID, you must specify at least one of ImageId, ImageName, and ImageFamily.
ImageFamily	String	No	CentOS7	The name of the image family. You can specify this parameter to obtain the most recent list of available images in the current image family for instance creation. If you specify ImageId, you cannot specify ImageFamily. Note If you do not specify the scaling group ID, you must specify at least one of ImageId, ImageName, and ImageFamily.
DataDiskCategories.N	String	No	cloud_essd	Category N of the data disks. Valid values: cloud: the basic disk. cloud_efficiency: the ultra disk. cloud_ssd: the standard SSD. cloud_essd: the ESSD. ephemeral_ssd: the local SSD.
Ipv6AddressCount	Integer	No	1	The number of IPv6 addresses. If the instance type that you specified does not meet the required number of IPv6 addresses, the scaling strength is weak. Note If you do not specify the scaling group ID, you must specify this parameter.

Response parameters

Parameter	Type	Example	Description
RequestId	String	73469C7-AA6F-4DC5-B3DB-A3DC0DE3****	The ID of the request.
TotalStrength	double	1.5	The total scaling strength of the scaling group. Each instance type + zone combination is scored from 0 (weakest) to 1 (strongest) based on availability. The scaling strength of the scaling group is measured based on the combined scores of all instance type + zone combinations. Warning This parameter is deprecated.
ElasticStrength	String	Strong	The current scaling strength of the scaling group. Valid values: Strong Medium Weak
ResourcePools	Array of ResourcePool		The resource pools.
Strength	double	0.6	The scaling strength of the resource pool.
InstanceType	String	ecs.c7t.xlarge	The instance type of the resource pool.
ZoneId	String	cn-hangzhou-g	The zone ID of the resource pool.
VSwitchIds	Array of String	vsw-2ze0uc933kantv******	The IDs of the vSwitches.
Code	String	InstanceTypesOrDiskTypesNotSupported	The error code returned when the scaling strength is the weakest.
Msg	String	The instanceTypes or diskTypes are not supported.	The error message returned when the scaling strength is the weakest.
Status	String	Available	Indicates whether the resource pool is available. Valid values: Available Unavailable If a constraint is not provided, the instance type is not deployed, or the instance type is out of stock, the resource pool becomes unavailable.
InventoryHealth	Object		The inventory health.
HealthScore	Integer	3	The score of the inventory health. A score between 5 and 6 indicates a high inventory certainty. A score between 1 and 4 indicates an uncertain inventory. Select a reservation as necessary. A score between -3 and 0 indicates an inventory health alert. Select another instance type. Calculation formula: `HealthScore` = `AdequacyScore` `SupplyScore`: the score of the replenishment capability. `HotScore`: the score of the popularity.
AdequacyScore	Integer	3	The adequacy score. Valid values: 0 to 3.
SupplyScore	Integer	3	The score of the replenishment capability. Valid values: 0 to 3.
HotScore	Integer	3	The popularity score. Valid values: 0 to 3.
ElasticStrengthModels	Array of ElasticStrengthModel		The scaling strengths of scaling configurations that are queried at the same time.
ScalingGroupId	String	asg-wz98mnj7nblv9gc****	The ID of the scaling group.
ElasticStrength	String	Strong	The current scaling strength of the scaling group. Valid values: Strong Medium Weak
TotalStrength	double	5	The current scaling strength of the scaling group. Each instance type + zone combination is scored from 0 (weakest) to 1 (strongest) based on availability. The scaling strength of the scaling group is measured based on the combined scores of all instance type + zone combinations. Warning This parameter is deprecated.
ResourcePools	Array of ResourcePool		The resource pools.
InstanceType	String	ecs.r7.large	The instance type of the resource pool.
Strength	double	0.6	The scaling strength of the resource pool. Warning This parameter is deprecated.
ZoneId	String	cn-hangzhou-g	The zone ID of the resource pool.
VSwitchIds	Array of String	vsw-2ze6e8p4aid08lymlsguv	The IDs of the vSwitches.
Code	String	InstanceTypesOrDiskTypesNotSupported	The error code returned when the scaling strength is the weakest.
Msg	String	The instanceTypes or diskTypes are not supported.	The error message returned when the scaling strength is the weakest.
Status	String	Available	Indicates whether the resource pool is available. Valid values: Available Unavailable If a constraint is not provided, the instance type is not deployed, or the instance type is out of stock, the resource pool becomes unavailable.
InventoryHealth	Object		The inventory health.
HealthScore	Integer	3	The score of the inventory health. A score between 5 and 6 indicates a high inventory certainty. A score between 1 and 4 indicates an uncertain inventory. Select a reservation as necessary. A score between -3 and 0 indicates an inventory health alert. Select another instance type. Calculation formula: `HealthScore` = `AdequacyScore` + `SupplyScore` - `HotScore`.
AdequacyScore	Integer	3	The adequacy score. Valid values: 0 to 3.
SupplyScore	Integer	2	The score of the replenishment capability. Valid values: 0 to 3.
HotScore	Integer	0	The popularity score. Valid values: 0 to 3.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeElasticStrength
&RegionId=cn-qingdao
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&InstanceTypes=["ecs.g6.large"]
&PriorityStrategy=NoSpot
&SystemDiskCategories=["cloud"]
&ScalingGroupIds=["asg-bp14wlu85wrpchm0****"]
&SpotStrategy=NoSpot
&VSwitchIds=["vsw-bp1whw2u46cn8zubm****"]
&ImageId=centos6u5_64_20G_aliaegis****.vhd
&ImageName=ubuntu_18_04_x64_20G_alibase_20231225.vhd
&ImageFamily=CentOS7
&DataDiskCategories=["cloud_essd"]
&Ipv6AddressCount=1
&<Common request parameters>

Sample success responses

XML format

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

<DescribeElasticStrengthResponse>
    <RequestId>73469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <TotalStrength>1.5</TotalStrength>
    <ElasticStrength>Strong</ElasticStrength>
    <ResourcePools>
        <Strength>0.6</Strength>
        <InstanceType>ecs.c7t.xlarge</InstanceType>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <VSwitchIds>vsw-2ze0uc933kantv******</VSwitchIds>
        <Code>InstanceTypesOrDiskTypesNotSupported</Code>
        <Msg>The instanceTypes or diskTypes are not supported.</Msg>
        <Status>Available</Status>
        <InventoryHealth>
            <HealthScore>3</HealthScore>
            <AdequacyScore>3</AdequacyScore>
            <SupplyScore>3</SupplyScore>
            <HotScore>3</HotScore>
        </InventoryHealth>
    </ResourcePools>
    <ElasticStrengthModels>
        <ScalingGroupId>asg-wz98mnj7nblv9gc****</ScalingGroupId>
        <ElasticStrength>Strong</ElasticStrength>
        <TotalStrength>5</TotalStrength>
        <ResourcePools>
            <InstanceType>ecs.r7.large</InstanceType>
            <Strength>0.6</Strength>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <VSwitchIds>vsw-2ze6e8p4aid08lymlsguv</VSwitchIds>
            <Code>InstanceTypesOrDiskTypesNotSupported</Code>
            <Msg>The instanceTypes or diskTypes are not supported.</Msg>
            <Status>Available</Status>
            <InventoryHealth>
                <HealthScore>3</HealthScore>
                <AdequacyScore>3</AdequacyScore>
                <SupplyScore>2</SupplyScore>
                <HotScore>0</HotScore>
            </InventoryHealth>
        </ResourcePools>
    </ElasticStrengthModels>
</DescribeElasticStrengthResponse>

JSON format

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

{
  "RequestId" : "73469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalStrength" : 1.5,
  "ElasticStrength" : "Strong",
  "ResourcePools" : [ {
    "Strength" : 0.6,
    "InstanceType" : "ecs.c7t.xlarge",
    "ZoneId" : "cn-hangzhou-g",
    "VSwitchIds" : [ "vsw-2ze0uc933kantv******" ],
    "Code" : "InstanceTypesOrDiskTypesNotSupported",
    "Msg" : "The instanceTypes or diskTypes are not supported.",
    "Status" : "Available",
    "InventoryHealth" : {
      "HealthScore" : 3,
      "AdequacyScore" : 3,
      "SupplyScore" : 3,
      "HotScore" : 3
    }
  } ],
  "ElasticStrengthModels" : [ {
    "ScalingGroupId" : "asg-wz98mnj7nblv9gc****",
    "ElasticStrength" : "Strong",
    "TotalStrength" : 5,
    "ResourcePools" : [ {
      "InstanceType" : "ecs.r7.large",
      "Strength" : 0.6,
      "ZoneId" : "cn-hangzhou-g",
      "VSwitchIds" : [ "vsw-2ze6e8p4aid08lymlsguv" ],
      "Code" : "InstanceTypesOrDiskTypesNotSupported",
      "Msg" : "The instanceTypes or diskTypes are not supported.",
      "Status" : "Available",
      "InventoryHealth" : {
        "HealthScore" : 3,
        "AdequacyScore" : 3,
        "SupplyScore" : 2,
        "HotScore" : 0
      }
    } ]
  } ]
}

Error codes

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