首页 弹性伸缩 开发参考 API参考 API参考(2022-02-22) API目录 伸缩组 DescribeElasticStrength - 查询伸缩组的弹性强度

DescribeElasticStrength - 查询伸缩组的弹性强度

更新时间: 2024-12-20 11:10:30

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:DescribeElasticStrengthget
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

伸缩组所属地域的 ID。

cn-qingdao
ScalingGroupIdstring

伸缩组的 ID。

asg-bp18p2yfxow2dloq****
InstanceTypesarray

ECS 实例的实例规格的集合。 传入时,覆盖伸缩配置中的实例规格。

string

ECS 实例规格。

ecs.g6.large
PriorityStrategystring

警告 此字段已废弃,请使用 SpotStrategy。
后付费实例的抢占策略。传入时覆盖伸缩组配置的抢占策略,取值范围:

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

默认值:NoSpot。

NoSpot
SystemDiskCategoriesarray

多个系统盘类型。 传入时,覆盖伸缩配置中的系统盘类型。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
说明 当不指定伸缩组 ID 时,需要传入此参数。
string

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

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
cloud
ScalingGroupIdsarray

批量查询时的查询伸缩组的 ID 列表。

string

伸缩组的 ID。

asg-bp14wlu85wrpchm0****
SpotStrategystring

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

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

默认值:NoSpot。

NoSpot
VSwitchIdsarray

指定多个交换机 ID。

说明 当不指定伸缩组 ID 时,需要传入此参数。
string

交换机 ID。

vsw-bp1whw2u46cn8zubm****
ImageIdstring

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

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

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

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

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

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

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

查询指定了多种数据盘类型时的弹性强度,当存在数据盘类型不匹配时,查询结果中会返回具体的不匹配磁盘类型。

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

数据盘类型。可能值:

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

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

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

73469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalStrengthdouble

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

警告 该字段已废弃。

1.5
ResourcePoolsarray<object>

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

ResourcePoolobject
Strengthdouble

资源池的弹性强度。

0.6
InstanceTypestring

资源池的实例规格。

ecs.c7t.xlarge
ZoneIdstring

资源池的可用区 ID。

cn-hangzhou-g
VSwitchIdsarray

资源池的可用区中的交换机。

VSwitchIdstring

交换机 ID。

vsw-2ze0uc933kantv******
Codestring

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

IMG_NOT_SUPPORTED
Msgstring

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

The instanceType does not support the image in the configuration.
ElasticStrengthModelsarray<object>

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

ElasticStrengthModelobject
ScalingGroupIdstring

伸缩组 ID。

asg-wz98mnj7nblv9gc****
ElasticStrengthstring

当前伸缩组的弹性强度。可能值:

  • Strong:弹性强度高。
  • Medium:弹性强度中。
  • Weak:弹性强度弱。
Strong
TotalStrengthdouble

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

警告 该字段已废弃。

1.5
ResourcePoolsarray<object>

每个资源池的弹性强度信息。

ResourcePoolobject
InstanceTypestring

资源池的实例规格。

ecs.r7.large
Strengthdouble

资源池的弹性强度。

警告 该字段已废弃。

0.6
ZoneIdstring

资源池的可用区 ID。

cn-hangzhou-g
VSwitchIdsarray

资源池的可用区中的交换机。

VSwitchIdstring

交换机 ID。

vsw-2ze6e8p4******
Codestring

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

InstanceTypesOrDiskTypesNotSupported
Msgstring

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

The instanceTypes or diskTypes are not supported.
Statusstring

资源池是否可用。可能值:

  • Available: 可用。
  • Unavailable: 不可用。约束不通过、规格未部署、规格无库存等会导致规格不可用。
Available
InventoryHealthobject

库存健康度。

HealthScoreinteger

库存健康分。

  • 5~6 分:表示供应确定性很高。
  • 1~4 分:表示确定性没有保障,建议按需选择预定。
  • -3~0 分:表示供应健康出现预警,建议更换规格。

计算公式:HealthScore(库存健康分) = AdequacyScore(充足度) + SupplyScore(补货能力) - HotScore(热度)。

3
AdequacyScoreinteger

充足度。

可能值:0~3。

3
SupplyScoreinteger

补货能力。

可能值:0~3。

2
HotScoreinteger

热度。

可能值:0~3。

0

示例

正常返回示例

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": "IMG_NOT_SUPPORTED",
      "Msg": "The instanceType does not support the image in the configuration."
    }
  ],
  "ElasticStrengthModels": [
    {
      "ScalingGroupId": "asg-wz98mnj7nblv9gc****",
      "ElasticStrength": "Strong",
      "TotalStrength": 1.5,
      "ResourcePools": [
        {
          "InstanceType": "ecs.r7.large",
          "Strength": 0.6,
          "ZoneId": "cn-hangzhou-g",
          "VSwitchIds": [
            "vsw-2ze6e8p4******"
          ],
          "Code": "InstanceTypesOrDiskTypesNotSupported",
          "Msg": "The instanceTypes or diskTypes are not supported.",
          "Status": "Available",
          "InventoryHealth": {
            "HealthScore": 3,
            "AdequacyScore": 3,
            "SupplyScore": 2,
            "HotScore": 0
          }
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-12-18OpenAPI 返回结构发生变更查看变更详情
2024-12-02OpenAPI 入参发生变更查看变更详情
上一篇: ApplyScalingGroup - 基于配置文件管理伸缩组 下一篇: 伸缩配置
阿里云首页 弹性伸缩 相关技术圈