DescribeElasticStrength

伸缩组配置的有效性很大程度决定了扩容过程的成功率。弹性伸缩通过弹性强度描述伸缩配置的有效性,让配置的优良程度量化,帮助您针对性的优化伸缩配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeElasticStrength

系统规定参数。取值:DescribeElasticStrength

RegionId String cn-qingdao

伸缩组所属地域的ID。

ScalingGroupId String asg-bp18p2yfxow2dloq****

伸缩组的ID。

InstanceTypes.N String ecs.g6.large

ECS实例的实例规格。

PriorityStrategy String NoSpot
说明 此字段已废弃,请使用SpotStrategy。

后付费实例的抢占策略。传入时覆盖伸缩组配置的抢占策略,取值范围:

  • NoSpot:普通的按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。

默认值:NoSpot。

SystemDiskCategories.N String cloud

系统盘的多磁盘类型。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD云盘。
ScalingGroupIds.N String asg-bp14wlu85wrpchm0****

伸缩组的ID。

SpotStrategy String NoSpot

实例的抢占策略。取值范围:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

默认值:NoSpot。

VSwitchIds.N String vsw-bp1whw2u46cn8zubm****

指定多个交换机ID。

说明 当不指定伸缩组ID时,需要传入此参数。
ImageId String centos6u5_64_20G_aliaegis****.vhd

镜像文件ID,自动创建实例时使用的镜像资源。

说明 当不指定伸缩组ID时,需要至少指定ImageId、ImageName、ImageFamily中的一个。
ImageName String ubuntu_18_04_x64_20G_alibase_20231225.vhd

镜像文件名称,同一个地域内镜像名称唯一。如果设置了ImageId,ImageName将被忽略。

不支持通过ImageName设置镜像市场镜像。

说明 当不指定伸缩组ID时,需要至少指定ImageId、ImageName、ImageFamily中的一个。
ImageFamily String CentOS7

镜像族系名称,通过设置该参数来获取当前镜像族系内最新的可用镜像,用于创建实例。如果已经设置了参数ImageId,则不能设置该参数。

说明 当不指定伸缩组ID时,需要至少指定ImageId、ImageName、ImageFamily中的一个。
DataDiskCategories.N String cloud_essd

数据盘类型。可能值:

  • cloud:普通云盘
  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD云盘
  • ephemeral_ssd:本地SSD盘
Ipv6AddressCount Integer 1

IPv6地址数。当实例规格不满足IPv6地址数量要求时,会导致弹性强度差。

说明 当不指定伸缩组ID时,可以传入此参数。

返回数据

名称

类型

示例值

描述

RequestId String 73469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

TotalStrength double 1.5

伸缩组的弹性强度。每个实例规格+可用区的组合根据供应情况得分为0到1分,其中0分代表弹性强度低,1分代表弹性强度高。所有实例规格+可用区的组合的得分总和为伸缩组的弹性强度。

ResourcePools Array of ResourcePool

查询单个伸缩组时的弹性强度。

Strength double 0.6

资源池的弹性强度。

InstanceType String ecs.c7t.xlarge

资源池的实例规格。

ZoneId String cn-hangzhou-g

资源池的可用区ID。

VSwitchIds Array of String vsw-2ze0uc933kantv******

交换机ID。

Code String InstanceTypesOrDiskTypesNotSupported

弹性强度为0时的原因(错误码)。

Msg String The instanceTypes or diskTypes are not supported.

弹性强度为0时的原因(错误描述)。

ElasticStrengthModels Array of ElasticStrengthModel

批量查询伸缩组时的弹性强度。

ScalingGroupId String asg-wz98mnj7nblv9gc****

伸缩组ID。

TotalStrength double 5

当前伸缩组的弹性强度。

ResourcePools Array of ResourcePool

每个资源池的弹性强度。

InstanceType String ecs.r7.large

资源池的实例规格。

Strength double 0.6

资源池的弹性强度。

ZoneId String cn-hangzhou-g

资源池的可用区ID。

VSwitchIds Array of String vsw-2ze6e8p4aid08lymlsguv

交换机ID。

Code String InstanceTypesOrDiskTypesNotSupported

弹性强度为0时的原因(错误码)。

Msg String The instanceTypes or diskTypes are not supported.

弹性强度为0时的原因(错误描述)。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeElasticStrength
&RegionId=cn-hangzhou
&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
&公共请求参数

正常返回示例

XML格式

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

<DescribeElasticStrengthResponse>
    <RequestId>73469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <TotalStrength>1.5</TotalStrength>
    <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>
    </ResourcePools>
    <ElasticStrengthModels>
        <ScalingGroupId>asg-wz98mnj7nblv9gc****</ScalingGroupId>
        <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>
        </ResourcePools>
    </ElasticStrengthModels>
</DescribeElasticStrengthResponse>

JSON格式

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

{
  "RequestId" : "73469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalStrength" : 1.5,
  "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."
  } ],
  "ElasticStrengthModels" : [ {
    "ScalingGroupId" : "asg-wz98mnj7nblv9gc****",
    "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."
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。