DescribeCandidateInstanceType - 查询备选的实例规格 - 弹性伸缩

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	伸缩组所属地域的 ID。	cn-qingdao
InstanceTypes	array	否	当前已选的 ECS 实例规格列表。
	string	否	当前已选的 ECS 实例规格列表。	ecs.g6.large
ZoneIds	array	否	当前已选的可用区列表。
	string	否	可用区 ID。	cn-hangzhou-b
AllowDifferentGeneration	boolean	否	是否允许补充其他代系的实例规格。例如当前规格为 ecs.c7.large，开启后可备选 ecs.c6.large 和 ecs.c8.large 等规格。	true
AllowCrossAz	boolean	否	是否允许补充其他可用区的交换机。说明规格不变，仅备选新的可用区。当伸缩组由于库存等问题导致所有已选可用区均无法扩容时，会根据此配置自动增加新的可用区交换机到伸缩组中。例如，伸缩组配置了 cn-hangzhou-h 和 cn-hangzhou-g 可用区，当两个可用区均无法扩容时 ESS 可能会根据实时库存状况创建一个 cn-hangzhou-k 的交换机并添加到伸缩组中。	true
MaxPrice	float	否	备选实例规格的价格上限。	2
SpotStrategy	string	否	后付费实例的抢占策略。取值范围： NoSpot：普通的按量付费实例。 SpotWithPriceLimit：设置上限价格的抢占式实例。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。默认值：NoSpot。	NoSpot
SystemDiskCategories	array	否	系统盘的多磁盘类型。第一个磁盘类型优先级最高，其他磁盘类型的优先级依次递减。当无法使用高优先级的磁盘类型时，弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。可能值：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD 云盘。cloud_essd：ESSD 云盘。
	string	否	系统盘的多磁盘类型。可能值： cloud：普通云盘。 cloud_efficiency：高效云盘。 cloud_ssd：SSD 云盘。 cloud_essd：ESSD 云盘。说明指定本参数时，不允许同时指定`SystemDisk.Category`。	cloud
DataDiskCategories	array	否	数据盘的多磁盘类型。当无法使用高优先级的磁盘类型时，弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。可能值：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD 云盘。cloud_essd：ESSD 云盘。ephemeral_ssd：本地 SSD 盘。
	string	否	数据盘类型。可能值： cloud：普通云盘。 cloud_efficiency：高效云盘。 cloud_ssd：SSD 云盘。 cloud_essd：ESSD 云盘。 ephemeral_ssd：本地 SSD 盘。	cloud_essd
ImageId	string	否	镜像文件 ID，自动创建实例时使用的镜像资源。说明如果伸缩配置之前使用的镜像包括系统盘和数据盘，修改此镜像后，原数据盘信息会被清除。	centos6u5_64_20G_aliaegis****.vhd
ImageName	string	否	镜像文件名称，同一个地域内镜像名称唯一。不支持通过该参数设置镜像市场中的镜像。说明该参数与`ImageId`参数作用相同，您可以根据实际情况进行二选一设置，即如果设置了`ImageId`参数，则`ImageName`参数将被忽略（非必填项）。	centos6u5_64_20G_aliaegis_20140703.vhd
ImageFamily	string	否	镜像族系名称，通过设置该参数来获取当前镜像族系内最新的可用镜像，用于创建实例。如果已经设置了参数 ImageId，则不能设置该参数。说明当不指定伸缩组 ID 时，需要至少指定 ImageId、ImageName、ImageFamily 中的一个。	hangzhou-daily-update
Ipv6AddressCount	integer	否	IPv6 地址数。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
CandidateInstanceTypes	array	可备选的 ECS 实例规格列表。
CandidateInstanceType	string	可备选的 ECS 实例规格列表。	ecs.c7a.2xlarge
CandidateZoneIds	array	可备选的可用区列表。
CandidateZoneId	string	可备选的可用区 ID。	cn-hangzhou-k

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "CandidateInstanceTypes": [
    "ecs.c7a.2xlarge"
  ],
  "CandidateZoneIds": [
    "cn-hangzhou-k"
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2026-04-03	新增 OpenAPI	查看变更详情