伸缩组配置的有效性很大程度决定了扩容过程的成功率。弹性伸缩通过弹性强度描述伸缩配置的有效性,让配置的优良程度量化,帮助用户针对性的优化伸缩配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:DescribeElasticStrength | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 伸缩组所属地域的 ID。 | cn-qingdao |
ScalingGroupId | string | 否 | 伸缩组的 ID。 | asg-bp18p2yfxow2dloq**** |
InstanceTypes | array | 否 | ECS 实例的实例规格的集合。 传入时,覆盖伸缩配置中的实例规格。 | |
string | 否 | ECS 实例规格。 | ecs.g6.large | |
PriorityStrategy | string | 否 | 警告 此字段已废弃,请使用 SpotStrategy。
默认值:NoSpot。 | NoSpot |
SystemDiskCategories | array | 否 | 多个系统盘类型。 传入时,覆盖伸缩配置中的系统盘类型。取值范围:
说明
当不指定伸缩组 ID 时,需要传入此参数。
| |
string | 否 | 系统盘的多磁盘类型。取值范围:
| cloud | |
ScalingGroupIds | array | 否 | 批量查询时的查询伸缩组的 ID 列表。 | |
string | 否 | 伸缩组的 ID。 | asg-bp14wlu85wrpchm0**** | |
SpotStrategy | string | 否 | 实例的抢占策略。取值范围:
默认值:NoSpot。 | NoSpot |
VSwitchIds | array | 否 | 指定多个交换机 ID。 说明
当不指定伸缩组 ID 时,需要传入此参数。
| |
string | 否 | 交换机 ID。 | vsw-bp1whw2u46cn8zubm**** | |
ImageId | string | 否 | 镜像文件 ID,自动创建实例时使用的镜像资源。 说明
当不指定伸缩组 ID 时,需要至少指定 ImageId、ImageName、ImageFamily 中的一个。
| centos6u5_64_20G_aliaegis****.vhd |
ImageName | string | 否 | 镜像文件名称,同一个地域内镜像名称唯一。如果设置了 ImageId,ImageName 将被忽略。 不支持通过 ImageName 设置镜像市场镜像。 说明
当不指定伸缩组 ID 时,需要至少指定 ImageId、ImageName、ImageFamily 中的一个。
| ubuntu_18_04_x64_20G_alibase_20231225.vhd |
ImageFamily | string | 否 | 镜像族系名称,通过设置该参数来获取当前镜像族系内最新的可用镜像,用于创建实例。如果已经设置了参数 ImageId,则不能设置该参数。 说明
当不指定伸缩组 ID 时,需要至少指定 ImageId、ImageName、ImageFamily 中的一个。
| CentOS7 |
DataDiskCategories | array | 否 | 查询指定了多种数据盘类型时的弹性强度,当存在数据盘类型不匹配时,查询结果中会返回具体的不匹配磁盘类型。 说明
当不指定伸缩组 ID 时,可以传入此参数。
| |
string | 否 | 数据盘类型。可能值:
| cloud_essd | |
Ipv6AddressCount | integer | 否 | IPv6 地址数。当实例规格不满足 IPv6 地址数量要求时,会导致弹性强度差。 说明
当不指定伸缩组 ID 时,可以传入此参数。
| 1 |
返回参数
示例
正常返回示例
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-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-12-02 | OpenAPI 入参发生变更 | 查看变更详情 |