(Beta)调用DescribeRecommendInstanceType根据一个指定的实例规格,查找一个或多个备选的实例规格。针对已经或者即将停售的实例规格,DescribeRecommendInstanceType会罗列出作为替补的所有实例规格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Cores | integer | 否 | ECS 实例 vCPU 核数。 说明
同时指定 Cores 参数和Memory 参数会匹配所有满足 vCPU 核数和内存大小的实例规格。
| 2 |
Memory | float | 否 | ECS 实例内存大小,单位为 GiB。 说明
同时指定 Cores 参数和Memory 参数会匹配所有满足 vCPU 核数和内存大小的实例规格。
| 8.0 |
InstanceFamilyLevel | string | 否 | 实例规格族级别。取值范围:
| EnterpriseLevel |
InstanceType | string | 否 | 指定的实例规格。更多详情,请参见实例规格族,也可以调用 DescribeInstanceTypes 接口获得最新的规格表。 说明
如果您指定了 InstanceType ,则无法指定Cores 或者Memory 。
| ecs.hfg6.large |
NetworkType | string | 是 | ECS 实例的网络类型。取值范围:
默认值:vpc | vpc |
InstanceChargeType | string | 否 | PostPaid | |
SpotStrategy | string | 否 | 抢占式实例的竞价策略。取值范围:
说明
使用 SpotStrategy 时,InstanceChargerType 必须设置为PostPaid 。
默认值:NoSpot | NoSpot |
IoOptimized | string | 否 | 是否为 I/O 优化实例。实例规格只支持非 I/O 优化时,不能设置 IoOptimized 参数。取值范围:
默认值:optimized 如果您设置的是已停售实例规格。默认值:none | optimized |
PriorityStrategy | string | 否 | 优先推荐策略。取值范围:
默认值:InventoryFirst | PriceFirst |
MaxPrice | float | 否 | 按量付费实例或者抢占式实例可接受的每小时最高价格。 说明
设置抢占式实例的最高单价时, SpotStrategy 必须设置为SpotWithPriceLimit 。
| 10.0 |
RegionId | string | 是 | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ZoneId | string | 否 | 可用区 ID。您可以调用 DescribeZones 查看最新的阿里云可用区列表。 建议同时 ZoneMatchMode 取值为 Include(默认值),优先推荐 ZoneId 指定的可用区中的实例规格,并列出同地域下其他可用区中的实例规格。 | cn-hangzhou-f |
SystemDiskCategory | string | 否 | 系统盘的云盘种类。取值范围:
非 I/O 优化实例的默认值:cloud I/O 优化实例的默认值:cloud_efficiency | cloud_ssd |
ZoneMatchMode | string | 否 | 是否仅推荐 ZoneId 指定的可用区中的实例规格。取值范围:
当指定 | Strict |
Scene | string | 否 | 在哪种场景下推荐实例规格。取值范围:
默认值:CREATE | CREATE |
InstanceTypeFamily | array | 否 | 设置备选的实例规格族集合,备选的实例规格会从该参数设置的实例规格族中选择。最多可输入 10 个实例规格族。 | |
string | 否 | 实例的规格族。规格族取值请参见实例规格族。您也可以调用 DescribeInstanceTypeFamilys 查询规格族列表。 | ecs.hfg6 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | RecommendEmpty.InstanceTypeNotAuthorized | The recommend instanceTypes are not authorized. | 推荐集合为空。地域/可用区下无合适的备选规格。 |
400 | RecommendEmpty.InstanceTypeSoldOut | The recommend instanceTypes are out of usage. | 推荐规格集合为空,可用区/地域下规格售罄,无合适备选规格。 |
400 | RecommendEmpty.DiskCategoryNotRecommended | The specified disk category is not available for recommended. | - |
400 | InvalidNetworkType.ValueNotSupported | The specified parameter NetworkType is not valid. | 指定的网络类型不合法。 |
400 | InvalidSpotStrategy.ValueNotSupported | The specified parameter SpotStrategy is not valid. | - |
400 | InvalidInstanceChargeType.NotFound | The specified parameter InstanceChargeType is not valid. | 无效的实例计费类型 |
400 | InvalidPriorityStrategy.ValueNotSupported | The specified parameter PriorityStrategy is not supported. | - |
400 | InvalidParam.TypeAndCpuMem.Conflict | The specified parameters InstanceType and Cores,Memory should not be blank at the same time. | 不能同时将参数 `InstanceType` 和 `Cores`、`Memory` 设置为空 |
400 | InvalidIoOptimized.NotFound | The specified parameter IoOptimized is not valid. | - |
400 | InvalidRegionId.MalFormed | The specified parameter RegionId is not valid. | 指定的 RegionId 不合法。 |
400 | InvalidDiskCategory.NotFound | The specified parameter SystemDiskCategory is not supported. | - |
400 | InvalidInstanceTypeFamily.NotFound | The specified InstanceTypeFamily is not valid. | - |
400 | InvalidMaxPrice.NotSupported | The specified MaxPrice is not valid. | 指定的最大价格字段信息无效。该字段只有在竞价实例场景下有效,必须大于0。 |
400 | InvalidZoneId.MalFormed | The specified ZoneId is not valid when Cores and Memory is not null. | - |
400 | InvalidInstanceType.NotSupported | The specified InstanceType is not valid. | 指定的实例规格无效 |
400 | InvalidZoneId.ValueNotSupported | The specified ZoneId is not valid. | 指定 ZoneId 无效。 |
400 | InvalidCoreAndMemory.ValueNotSupported | The specified Cores/Memory does not match instance type. | - |
400 | QuotaExceed.AfterpayInstance | Living afterpay instances quota exceeded. | 活跃的按量付费实例数已达上限。 |
400 | RecommendEmpty.PerformanceNotSatisfied | The performance of recommend instanceType is not satisfied. | - |
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.IzNotMatched | The iz of recommend instanceTypes are not match. | - |
400 | RecommendEmpty.InstanceTypeNotMatched | The recommend instanceTypes are not match. | - |
400 | InvalidScene.ValueNotSupported | The specified Scene is invalid. | - |
400 | RecommendEmpty.InstanceTypeFamilyNotMatched | The recommend instanceTypeFamily are not match. | 推荐集合为空,地域/可用区下无满足规格族集合要求的可选规格。 |
400 | RecommendEmpty.GenerationNotMatch | The recommend instanceType generation are not match. | - |
400 | RecommendEmpty.NetworkTypeNotSupported | The recommend instanceType networkType are not match. | - |
400 | InvalidInstanceFamilyLevel.NotSupported | The specified InstanceFamilyLevel is not valid. | 输入InstanceFamilyLevel信息无效。 |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-07 | OpenAPI 错误码发生变更 | 查看变更详情 |