(Beta)调用DescribeRecommendInstanceType根据一个指定的实例规格,查找一个或多个备选的实例规格。针对已经或者即将停售的实例规格,DescribeRecommendInstanceType会罗列出作为替补的所有实例规格。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeRecommendInstanceType

系统规定参数。取值:DescribeRecommendInstanceType

NetworkType String vpc

ECS实例的网络类型。取值范围:

  • classic:经典网络
  • vpc:专有网络VPC

默认值:vpc

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ZoneId String cn-hangzhou-f

可用区ID。您可以调用DescribeZones查看最新的阿里云可用区列表。

建议同时ZoneMatchMode取值为Include(默认值),优先推荐ZoneId指定的可用区中的实例规格,并列出同地域下其他可用区中的实例规格。

ZoneMatchMode String Strict

是否仅推荐ZoneId指定的可用区中的实例规格。取值范围:

  • Strict:仅推荐ZoneId指定的可用区中的实例规格。
  • Include:推荐同地域下其他可用区中的实例规格。

当指定ZoneId时,该参数的默认值为Strict,表示仅推荐ZoneId指定的可用区中的实例规格。

InstanceType String ecs.hfg6.large

指定的实例规格。更多详情,请参见实例规格族,也可以调用DescribeInstanceTypes接口获得最新的规格表。

说明 如果您指定了InstanceType,则无法指定Cores或者Memory
InstanceFamilyLevel String EnterpriseLevel

实例规格族级别。取值范围:

  • EntryLevel:入门级。
  • EnterpriseLevel:企业级。
  • CreditEntryLevel:积分入门级。详情请参见突发性能实例
Cores Integer 2

ECS实例vCPU核数。

说明 同时指定Cores参数和Memory参数会匹配所有满足vCPU核数和内存大小的实例规格。
Memory Float 8.0

ECS实例内存大小,单位为GiB。

说明 同时指定Cores参数和Memory参数会匹配所有满足vCPU核数和内存大小的实例规格。
SpotStrategy String NoSpot

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

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,最高按量付费价格。
说明 使用SpotStrategy时,InstanceChargerType必须设置为PostPaid

默认值:NoSpot

InstanceChargeType String PostPaid

ECS实例的计费方式。更多详情,请参见计费概述。取值范围:

  • PrePaid:包年包月
  • PostPaid:按量付费

默认值:PostPaid

InstanceTypeFamily.N RepeatList ecs.hfg6

过滤不采纳的实例规格族集合,N的取值范围为1~10。规格族取值请参见实例规格族。您也可以调用DescribeInstanceTypeFamilys查询规格族列表。

PriorityStrategy String PriceFirst

优先推荐策略。取值范围:

  • InventoryFirst:库存优先。
  • PriceFirst:价格优先,按每小时vCPU单价从低到高排序。
  • NewProductFirst:最新产品优先。

默认值:InventoryFirst

MaxPrice Float 10.0

按量付费实例或者抢占式实例可接受的每小时最高价格。

说明 设置抢占式实例的最高单价时,SpotStrategy必须设置为SpotWithPriceLimit
IoOptimized String optimized

是否为I/O优化实例。实例规格只支持非I/O优化时,不能设置IoOptimized参数。取值范围:

  • optimized:I/O优化
  • none:非IO优化

默认值:optimized

如果您设置的是已停售实例规格。默认值:none

Scene String CREATE

在哪种场景下推荐实例规格。取值范围:

  • UPGRADE:升级或降低实例规格。
  • CREATE:创建实例。

默认值:CREATE

SystemDiskCategory String cloud_ssd

系统盘的云盘种类。取值范围:

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

非I/O优化实例的默认值:cloud

I/O优化实例的默认值:cloud_efficiency

返回数据

名称 类型 示例值 描述
Data Array of RecommendInstanceType

推荐的实例规格集合。

RecommendInstanceType
CommodityCode String ecs

实例规格的商品编码。

InstanceChargeType String PostPaid

实例的计费方式。

InstanceType Struct

实例规格名称。

Cores Integer 1

实例规格的vCPU核数。

Generation String ecs-4

实例规格族系列。

InstanceType String ecs.hfg6.large

实例规格名称。

InstanceTypeFamily String ecs.hfg6

实例规格族。

Memory Integer 8192

实例规格的内存大小,单位为MB。

SupportIoOptimized String optimized

实例规格是否支持I/O优化。

NetworkType String vpc

ECS实例的网络类型。

Priority Integer 2

排序优先级。

RegionId String cn-hangzhou

实例规格所在的地域ID。

Scene String CREATE

在哪种场景下推荐实例规格。

SpotStrategy String NoSpot

抢占式实例的抢占策略。

ZoneId String cn-hangzhou-h

实例规格所在的可用区ID。

Zones Array of zone

实例规格所在的可用区集合。

zone
NetworkTypes List vpc

实例规格的网络类型集合。

ZoneNo String cn-hangzhou-h

实例规格所在的可用区ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

http://ecs.aliyuncs.com/?Action=DescribeRecommendInstanceType
&NetworkType=vpc
&ZoneId=cn-hangzhou-h
&ZoneMatchMode=Include
&InstanceType=ecs.hfg6.large
&InstanceTypeFamily.1=ecs.hfg6
&<公共请求参数>

正常返回示例

XML格式

<DescribeRecommendInstanceTypeResponse>
      <RequestId>5EEED58E-C640-4E62-B6E3-A251B5E910D5</RequestId>
      <Data>
            <RecommendInstanceType>
                  <ZoneId>cn-hangzhou-h</ZoneId>
                  <InstanceChargeType>PostPaid</InstanceChargeType>
                  <Priority>1</Priority>
                  <NetworkType>vpc</NetworkType>
                  <RegionId>cn-hangzhou</RegionId>
                  <Scene>CREATE</Scene>
                  <InstanceType>
                        <SupportIoOptimized>optimized</SupportIoOptimized>
                        <Cores>2</Cores>
                        <Generation>ecs-5</Generation>
                        <InstanceTypeFamily>ecs.hfg6</InstanceTypeFamily>
                        <Memory>8192</Memory>
                        <InstanceType>ecs.hfg6.large</InstanceType>
                  </InstanceType>
                  <SpotStrategy>NoSpot</SpotStrategy>
                  <Zones>
                        <zone>
                              <NetworkTypes>
                                    <NetworkType>vpc</NetworkType>
                              </NetworkTypes>
                              <ZoneNo>cn-hangzhou-h</ZoneNo>
                        </zone>
                  </Zones>
            </RecommendInstanceType>
            <RecommendInstanceType>
                  <ZoneId>cn-hangzhou-i</ZoneId>
                  <InstanceChargeType>PostPaid</InstanceChargeType>
                  <Priority>2</Priority>
                  <NetworkType>vpc</NetworkType>
                  <RegionId>cn-hangzhou</RegionId>
                  <Scene>CREATE</Scene>
                  <InstanceType>
                        <SupportIoOptimized>optimized</SupportIoOptimized>
                        <Cores>2</Cores>
                        <Generation>ecs-5</Generation>
                        <InstanceTypeFamily>ecs.hfg6</InstanceTypeFamily>
                        <Memory>8192</Memory>
                        <InstanceType>ecs.hfg6.large</InstanceType>
                  </InstanceType>
                  <SpotStrategy>NoSpot</SpotStrategy>
                  <Zones>
                        <zone>
                              <NetworkTypes>
                                    <NetworkType>vpc</NetworkType>
                              </NetworkTypes>
                              <ZoneNo>cn-hangzhou-i</ZoneNo>
                        </zone>
                  </Zones>
            </RecommendInstanceType>
            <RecommendInstanceType>
                  <ZoneId>cn-hangzhou-j</ZoneId>
                  <InstanceChargeType>PostPaid</InstanceChargeType>
                  <Priority>3</Priority>
                  <NetworkType>vpc</NetworkType>
                  <RegionId>cn-hangzhou</RegionId>
                  <Scene>CREATE</Scene>
                  <InstanceType>
                        <SupportIoOptimized>optimized</SupportIoOptimized>
                        <Cores>2</Cores>
                        <Generation>ecs-5</Generation>
                        <InstanceTypeFamily>ecs.hfg6</InstanceTypeFamily>
                        <Memory>8192</Memory>
                        <InstanceType>ecs.hfg6.large</InstanceType>
                  </InstanceType>
                  <SpotStrategy>NoSpot</SpotStrategy>
                  <Zones>
                        <zone>
                              <NetworkTypes>
                                    <NetworkType>vpc</NetworkType>
                              </NetworkTypes>
                              <ZoneNo>cn-hangzhou-j</ZoneNo>
                        </zone>
                  </Zones>
            </RecommendInstanceType>
      </Data>
</DescribeRecommendInstanceTypeResponse>

JSON格式

{
	"RequestId": "5EEED58E-C640-4E62-B6E3-A251B5E910D5",
	"Data": {
		"RecommendInstanceType": [
			{
				"ZoneId": "cn-hangzhou-h",
				"InstanceChargeType": "PostPaid",
				"Priority": 1,
				"NetworkType": "vpc",
				"RegionId": "cn-hangzhou",
				"Scene": "CREATE",
				"InstanceType": {
					"SupportIoOptimized": "optimized",
					"Cores": 2,
					"Generation": "ecs-5",
					"InstanceTypeFamily": "ecs.hfg6",
					"Memory": 8192,
					"InstanceType": "ecs.hfg6.large"
				},
				"SpotStrategy": "NoSpot",
				"Zones": {
					"zone": [
						{
							"NetworkTypes": {
								"NetworkType": [
									"vpc"
								]
							},
							"ZoneNo": "cn-hangzhou-h"
						}
					]
				}
			},
			{
				"ZoneId": "cn-hangzhou-i",
				"InstanceChargeType": "PostPaid",
				"Priority": 2,
				"NetworkType": "vpc",
				"RegionId": "cn-hangzhou",
				"Scene": "CREATE",
				"InstanceType": {
					"SupportIoOptimized": "optimized",
					"Cores": 2,
					"Generation": "ecs-5",
					"InstanceTypeFamily": "ecs.hfg6",
					"Memory": 8192,
					"InstanceType": "ecs.hfg6.large"
				},
				"SpotStrategy": "NoSpot",
				"Zones": {
					"zone": [
						{
							"NetworkTypes": {
								"NetworkType": [
									"vpc"
								]
							},
							"ZoneNo": "cn-hangzhou-i"
						}
					]
				}
			},
			{
				"ZoneId": "cn-hangzhou-j",
				"InstanceChargeType": "PostPaid",
				"Priority": 3,
				"NetworkType": "vpc",
				"RegionId": "cn-hangzhou",
				"Scene": "CREATE",
				"InstanceType": {
					"SupportIoOptimized": "optimized",
					"Cores": 2,
					"Generation": "ecs-5",
					"InstanceTypeFamily": "ecs.hfg6",
					"Memory": 8192,
					"InstanceType": "ecs.hfg6.large"
				},
				"SpotStrategy": "NoSpot",
				"Zones": {
					"zone": [
						{
							"NetworkTypes": {
								"NetworkType": [
									"vpc"
								]
							},
							"ZoneNo": "cn-hangzhou-j"
						}
					]
				}
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidNetworkType.ValueNotSupported The specified parameter NetworkType is not valid. 指定的网络类型不合法。
400 InvalidPriorityStrategy.ValueNotSupported The specified PriorityStrategy is not supported. 当前操作不支持您指定的排序策略。
400 InvalidParam.TypeAndCpuMem.Conflict The specified InstanceType and Cores,Memory are not blank at the same time. 不能同时指定实例规格InstanceType 和核数/内存(Cores、Memory、InstanceFamilyLevel)信息
400 InvalidRegionId.MalFormed The specified parameter RegionId is not valid. 指定的RegionId不合法。
400 InvalidZoneId.ValueNotSupported The specified ZoneId is not valid. 指定ZoneId无效。
400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded. 活跃的按量付费实例数已达上限。
400 RecommendEmpty.InstanceTypeSoldOut The recommend instanceTypes are out of usage. 推荐规格集合为空,可用区/地域下规格售罄,无合适备选规格。
400 RecommendEmpty.InstanceTypeNotAuthorized The recommend instanceTypes are not authorized. 推荐集合为空。地域/可用区下无合适的备选规格。
400 RecommendEmpty.PriceNotSatisfied The current price of recommend instanceTypes above user max price. 推荐集合为空,地域/可用区下无满足价格要求的可选规格。
400 RecommendEmpty.QuotaNotSatisfied The quota of recommend instanceTypes are out of usage. 推荐集合为空,地域/可用区下因quota受限,无可选规格。
400 RecommendEmpty.InstanceTypeFamilyNotMatched The recommend instanceTypeFamily are not match. 推荐集合为空,地域/可用区下无满足规格族集合要求的可选规格。

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