DescribeRecommendInstanceType - 查找备选实例规格

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

调试

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

授权信息

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

请求参数

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

ECS 实例 vCPU 核数。

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

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

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

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

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

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

说明 如果您指定了InstanceType,则无法指定Cores或者Memory
ecs.hfg6.large
NetworkTypestring

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

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

默认值:vpc

vpc
InstanceChargeTypestring

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

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

默认值:PostPaid

PostPaid
SpotStrategystring

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

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

默认值:NoSpot

NoSpot
IoOptimizedstring

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

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

默认值:optimized

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

optimized
PriorityStrategystring

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

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

默认值:InventoryFirst

PriceFirst
MaxPricefloat

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

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

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

cn-hangzhou
ZoneIdstring

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

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

cn-hangzhou-f
SystemDiskCategorystring

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

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

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

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

cloud_ssd
ZoneMatchModestring

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

  • Strict:仅推荐 ZoneId 指定的可用区中的实例规格。

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

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

Strict
Scenestring

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

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

默认值:CREATE

CREATE
InstanceTypeFamilyarray

设置备选的实例规格族集合,备选的实例规格会从该参数设置的实例规格族中选择。最多可输入 10 个实例规格族。

string

实例的规格族。规格族取值请参见实例规格族。您也可以调用 DescribeInstanceTypeFamilys 查询规格族列表。

ecs.hfg6

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Dataarray<object>

推荐的实例规格集合。

RecommendInstanceTypeobject
CommodityCodestring

实例规格的商品编码。

ecs
ZoneIdstring

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

cn-hangzhou-h
Priorityinteger

排序优先级。

2
NetworkTypestring

ECS 实例的网络类型。

vpc
Scenestring

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

CREATE
SpotStrategystring

抢占式实例的抢占策略。

NoSpot
RegionIdstring

实例规格所在的地域 ID。

cn-hangzhou
InstanceChargeTypestring

实例的计费方式。

PostPaid
Zonesarray<object>

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

zoneobject
ZoneNostring

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

cn-hangzhou-h
NetworkTypesarray

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

NetworkTypestring

实例规格的网络类型。

vpc
InstanceTypeobject

实例规格名称。

SupportIoOptimizedstring

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

optimized
Coresinteger

实例规格的 vCPU 核数。

1
Memoryinteger

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

8192
InstanceTypestring

实例规格名称。

ecs.hfg6.large
InstanceTypeFamilystring

实例规格族。

ecs.hfg6
Generationstring

实例规格族系列。

ecs-4

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "RecommendInstanceType": [
      {
        "CommodityCode": "ecs",
        "ZoneId": "cn-hangzhou-h",
        "Priority": 2,
        "NetworkType": "vpc",
        "Scene": "CREATE",
        "SpotStrategy": "NoSpot",
        "RegionId": "cn-hangzhou",
        "InstanceChargeType": "PostPaid",
        "Zones": {
          "zone": [
            {
              "ZoneNo": "cn-hangzhou-h",
              "NetworkTypes": {
                "NetworkType": [
                  "vpc"
                ]
              }
            }
          ]
        },
        "InstanceType": {
          "SupportIoOptimized": "optimized",
          "Cores": 1,
          "Memory": 8192,
          "InstanceType": "ecs.hfg6.large",
          "InstanceTypeFamily": "ecs.hfg6",
          "Generation": "ecs-4"
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400RecommendEmpty.InstanceTypeNotAuthorizedThe recommend instanceTypes are not authorized.推荐集合为空。地域/可用区下无合适的备选规格。
400RecommendEmpty.InstanceTypeSoldOutThe recommend instanceTypes are out of usage.推荐规格集合为空,可用区/地域下规格售罄,无合适备选规格。
400RecommendEmpty.DiskCategoryNotRecommendedThe specified disk category is not available for recommended.-
400InvalidNetworkType.ValueNotSupportedThe specified parameter NetworkType is not valid.指定的网络类型不合法。
400InvalidSpotStrategy.ValueNotSupportedThe specified parameter SpotStrategy is not valid.-
400InvalidInstanceChargeType.NotFoundThe specified parameter InstanceChargeType is not valid.无效的实例计费类型
400InvalidPriorityStrategy.ValueNotSupportedThe specified parameter PriorityStrategy is not supported.-
400InvalidParam.TypeAndCpuMem.ConflictThe specified parameters InstanceType and Cores,Memory should not be blank at the same time.不能同时将参数 `InstanceType` 和 `Cores`、`Memory` 设置为空
400InvalidIoOptimized.NotFoundThe specified parameter IoOptimized is not valid.-
400InvalidRegionId.MalFormedThe specified parameter RegionId is not valid.指定的 RegionId 不合法。
400InvalidDiskCategory.NotFoundThe specified parameter SystemDiskCategory is not supported.-
400InvalidInstanceTypeFamily.NotFoundThe specified InstanceTypeFamily is not valid.-
400InvalidMaxPrice.NotSupportedThe specified MaxPrice is not valid.指定的最大价格字段信息无效。该字段只有在竞价实例场景下有效,必须大于0。
400InvalidZoneId.MalFormedThe specified ZoneId is not valid when Cores and Memory is not null.-
400InvalidInstanceType.NotSupportedThe specified InstanceType is not valid.指定的实例规格无效
400InvalidZoneId.ValueNotSupportedThe specified ZoneId is not valid.指定 ZoneId 无效。
400InvalidCoreAndMemory.ValueNotSupportedThe specified Cores/Memory does not match instance type.-
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.活跃的按量付费实例数已达上限。
400RecommendEmpty.PerformanceNotSatisfiedThe performance of recommend instanceType is not satisfied.-
400RecommendEmpty.PriceNotSatisfiedThe current price of recommend instanceTypes above user max price.推荐集合为空,地域/可用区下无满足价格要求的可选规格。
400RecommendEmpty.QuotaNotSatisfiedThe quota of recommend instanceTypes are out of usage.推荐集合为空,地域/可用区下因quota受限,无可选规格。
400RecommendEmpty.IzNotMatchedThe iz of recommend instanceTypes are not match.-
400RecommendEmpty.InstanceTypeNotMatchedThe recommend instanceTypes are not match.-
400InvalidScene.ValueNotSupportedThe specified Scene is invalid.-
400RecommendEmpty.InstanceTypeFamilyNotMatchedThe recommend instanceTypeFamily are not match.推荐集合为空,地域/可用区下无满足规格族集合要求的可选规格。
400RecommendEmpty.GenerationNotMatchThe recommend instanceType generation are not match.-
400RecommendEmpty.NetworkTypeNotSupportedThe recommend instanceType networkType are not match.-
400InvalidInstanceFamilyLevel.NotSupportedThe specified InstanceFamilyLevel is not valid.输入InstanceFamilyLevel信息无效。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 错误码发生变更查看变更详情