DescribeElasticStrength - Auto Scaling - Alibaba Cloud Documentation Center

The validity of a scaling group configuration largely determines the success rate of scale-out operations. Auto Scaling uses elastic strength to describe the validity of scaling configurations, quantifying configuration quality and helping you optimize scaling configurations accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribeElasticStrength

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group.	cn-qingdao
ScalingGroupId	string	No	The ID of the scaling group.	asg-bp18p2yfxow2dloq****
InstanceTypes	array	No	The collection of instance types for ECS instances. If specified, this parameter overrides the instance types in the scaling configuration.
	string	No	The instance type of the ECS instance.	ecs.g6.large
PriorityStrategy	string	No	Note This parameter is deprecated. Use SpotStrategy instead. The preemption policy for pay-as-you-go instances. If specified, this parameter overrides the preemption policy configured for the scaling group. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot instance with a maximum price limit. SpotAsPriceGo: a spot instance priced at the current market rate. Default value: NoSpot.	NoSpot
SystemDiskCategories	array	No	The system cloud disk types. If specified, this parameter overrides the system cloud disk types in the scaling configuration. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: Enterprise SSD (ESSD). Note If you do not specify a scaling group ID, you must specify this parameter.
	string	No	The system cloud disk types. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: Enterprise SSD (ESSD).	cloud
ScalingGroupIds	array	No	The IDs of scaling groups for batch queries.
	string	No	The ID of the scaling group.	asg-bp14wlu85wrpchm0****
SpotStrategy	string	No	The preemption policy for instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot instance with a maximum price limit. SpotAsPriceGo: a spot instance priced at the current market rate. Default value: NoSpot.	NoSpot
VSwitchIds	array	No	The IDs of multiple vSwitches. Note If you do not specify a scaling group ID, you must specify this parameter.
	string	No	The IDs of multiple vSwitches. Note If you do not specify a scaling group ID, you must specify this parameter.	vsw-bp1whw2u46cn8zubm****
ImageId	string	No	The ID of the image file. The image resource used for automatic creation of instances. Note If you do not specify a scaling group ID, you must specify at least one of ImageId, ImageName, or ImageFamily.	centos6u5_64_20G_aliaegis****.vhd
ImageName	string	No	The name of the image. Image names are unique within a region. If ImageId is specified, ImageName is ignored. You cannot use ImageName to specify images from Alibaba Cloud Marketplace. Note If you do not specify a scaling group ID, you must specify at least one of ImageId, ImageName, or ImageFamily.	ubuntu_18_04_x64_20G_alibase_20231225.vhd
ImageFamily	string	No	The name of the image family. If you specify this parameter, the latest available image in the specified image family is used to create instances. If ImageId is already specified, you cannot specify this parameter. Note If you do not specify a scaling group ID, you must specify at least one of ImageId, ImageName, or ImageFamily.	CentOS7
DataDiskCategories	array	No	The elastic strength when multiple data cloud disk types are specified. If a data cloud disk type does not match, the specific mismatched disk type is returned in the query result. Note If you do not specify a scaling group ID, you can specify this parameter.
	string	No	The data cloud disk type. Valid values: cloud: basic cloud disk cloud_efficiency: ultra cloud disk cloud_ssd: standard SSD cloud_essd: Enterprise SSD (ESSD) ephemeral_ssd: local SSD.	cloud_essd
Ipv6AddressCount	integer	No	The number of IPv6 addresses. If the instance type does not meet the IPv6 address count requirement, the elastic strength is degraded. Note If you do not specify a scaling group ID, you can specify this parameter.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	73469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalStrength	number	The elastic strength of the scaling group. Each combination of instance type and zone is scored from 0 to 1 based on supply conditions, where 0 indicates low elastic strength and 1 indicates high elastic strength. The sum of scores for all instance type and zone combinations represents the elastic strength of the scaling group. Warning This parameter is deprecated. .	1.5
ElasticStrength	string	The elastic strength of the current scaling group. Valid values: Strong: high elastic strength. Medium: medium elastic strength. Weak: low elastic strength.	Strong
ResourcePools	array<object>	The elastic strength when querying a single scaling group.
	array<object>
Strength	number	The elastic strength of the resource pool.	0.6
InstanceType	string	The instance type of the resource pool.	ecs.c7t.xlarge
ZoneId	string	The zone ID of the resource pool.	cn-hangzhou-g
VSwitchIds	array	The vSwitches in the zone of the resource pool.
	string	The vSwitch ID.	vsw-2ze0uc933kantv******
Code	string	The reason (error code) when the elastic strength is 0.	InstanceTypesOrDiskTypesNotSupported
Msg	string	The reason (error description) when the elastic strength is 0.	The instanceTypes or diskTypes are not supported.
Status	string	Indicates whether the resource pool is available. Valid values: Available: available. Unavailable: unavailable. Constraint violations, undeployed instance types, or out-of-stock instance types can cause the instance type to be unavailable.	Available
InventoryHealth	object	The inventory health information.
HealthScore	integer	Inventory health score. Scores of 5–6 indicate very high supply certainty. Scores of 1–4 indicate uncertain supply; on-demand reservation is recommended. Scores of -3–0 indicate a warning for inventory health; changing the instance type is recommended. Calculation Formula: `HealthScore` (Inventory Health Score) = `AdequacyScore` (Adequacy) + `SupplyScore` (Replenishment Capability) - `HotScore` (Popularity).	3
AdequacyScore	integer	Adequacy. Possible values: 0–3.	3
SupplyScore	integer	Replenishment capability. Possible values: 0–3.	3
HotScore	integer	Popularity. Possible values: 0–3.	3
ElasticStrength	string	The elastic strength of the current resource pool, which takes into account both the inventory health and current inventory status of the resource pool. Valid values: Strong: high elastic strength. Medium: medium elastic strength. Weak: low elastic strength.	Medium
ElasticStrengthModels	array<object>	The elastic strength when querying scaling groups in batches.
	array<object>
ScalingGroupId	string	The scaling group ID.	asg-wz98mnj7nblv9gc****
ElasticStrength	string	The elastic strength of the current scaling group. Valid values: Strong: high elastic strength. Medium: medium elastic strength. Weak: low elastic strength.	Strong
TotalStrength	number	The elastic strength of the current scaling group. Each combination of instance type and zone is scored from 0 to 1 based on supply conditions, where 0 indicates low elastic strength and 1 indicates high elastic strength. The sum of scores for all instance type and zone combinations represents the elastic strength of the scaling group. Warning This parameter is deprecated. .	5
ResourcePools	array<object>	The elastic strength information for each resource pool.
	array<object>
InstanceType	string	Instance type of the resource pool.	ecs.r7.large
Strength	number	The elasticity strength of the resource pool. Warning This field is deprecated.	0.6
ZoneId	string	The zone ID of the resource pool.	cn-hangzhou-g
VSwitchIds	array	The vSwitches in the zone of the resource pool.
	string	The vSwitch ID.	vsw-2ze6e8p4aid08lymlsguv
Code	string	Reason (error code) when elasticity strength is 0.	InstanceTypesOrDiskTypesNotSupported
Msg	string	The reason (fault description) when the elasticity strength is 0.	The instanceTypes or diskTypes are not supported.
Status	string	Whether the resource pool is active. Possible values: Available: active. Unavailable: not active. A constraint may have failed, the specification may not be deployed, or the specification may have no inventory.	Available
InventoryHealth	object	Inventory health degree.
HealthScore	integer	Inventory health score. 5–6 points: Indicates very high supply certainty. 1–4 points: Indicates uncertain supply; on-demand reservation is recommended. -3–0 points: Indicates a warning in supply health; changing the instance type is recommended. Calculation Formula: `HealthScore` (inventory health score) = `AdequacyScore` (adequacy degree) + `SupplyScore` (supply capability) – `HotScore` (hotness degree).	3
AdequacyScore	integer	Adequacy degree. Possible values: 0–3.	3
SupplyScore	integer	Supply capability. Possible values: 0–3.	2
HotScore	integer	Hotness degree. Possible values: 0–3.	0
ElasticStrength	string		Strong

Examples

Success response

JSON format

{
  "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
      },
      "ElasticStrength": "Medium"
    }
  ],
  "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
          },
          "ElasticStrength": "Strong"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.