查询可用区的资源库存状态。您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源库存状态。
接口说明
参数DestinationResource
的取值有不同的逻辑与要求。在下列的顺序列表中,顺序越低的取值需要设置更多的参数,不支持通过低顺序的取值筛选高顺序的资源类别。
-
取值顺序:
Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk
-
取值示例:
-
若参数
DestinationResource
取值为DataDisk
:-
ResourceType
取值为disk
表示查询与 ECS 实例规格无关的数据盘类型,可以不传入参数InstanceType
。 -
ResourceType
取值为instance
表示查询与 ECS 实例同时购买的数据盘类型,因实例规格对系统盘及数据盘有一定的限制,所以需要同时指定InstanceType
与参数SystemDiskCategory
。
-
-
若参数
DestinationResource
取值为SystemDisk
,ResourceType
取值为instance
,由于 ECS 实例规格对系统盘存在限制,则必须要传入参数InstanceType
。 -
若参数
DestinationResource
取值为InstanceType
,建议传入参数IoOptimized
和InstanceType
。 -
查询指定地域下所有可用区的 ecs.g5.large 库存供应情况:
RegionId=cn-hangzhou &DestinationResource=InstanceType &IoOptimized=optimized &InstanceType=ecs.g5.large
。 -
查询指定地域下有 ecs.g5.large 库存供应的可用区列表:
RegionId=cn-hangzhou &DestinationResource=Zone &IoOptimized=optimized &InstanceType=ecs.g5.large
。
-
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 目标地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
InstanceChargeType | string | 否 | PrePaid | |
SpotStrategy | string | 否 | 按量付费实例的竞价策略。取值范围:
默认值:NoSpot。 当参数 | NoSpot |
SpotDuration | integer | 否 | 抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:
实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。 说明
当 InstanceChargeType 取值为PostPaid ,并且SpotStrategy 值为SpotWithPriceLimit 或SpotAsPriceGo 时该参数生效。
| 1 |
DestinationResource | string | 是 | 要查询的资源类型。取值范围:
说明
当 DestinationResource 取值为 SystemDisk 时,由于系统盘受实例规格限制,此时必须传入 InstanceType。
参数 DestinationResource 的取值方式请参见本文中的接口说明。 | InstanceType |
ZoneId | string | 否 | 可用区 ID。 默认值:无。返回该地域( | cn-hangzhou-e |
IoOptimized | string | 否 | 是否为 I/O 优化实例。取值范围:
默认值:optimized。 | optimized |
DedicatedHostId | string | 否 | 专有宿主机 ID。 | dh-bp165p6xk2tlw61e**** |
InstanceType | string | 否 | 实例规格。更多信息,请参见实例规格族,您也可以调用 DescribeInstanceTypes 接口获得最新的规格表。 参数 InstanceType 的取值方式请参见本文开头的接口说明。 | ecs.g5.large |
SystemDiskCategory | string | 否 | 系统盘类型。取值范围:
默认值:cloud_efficiency。 说明
参数 ResourceType 取值为 instance、DestinationResource 取值为 DataDisk 时,参数 SystemDiskCategory 是必选参数。如果未传递参数值,则以默认值生效。
| cloud_ssd |
DataDiskCategory | string | 否 | 数据盘类型。取值范围:
| cloud_ssd |
NetworkCategory | string | 否 | 网络类型。取值范围:
| vpc |
Cores | integer | 否 | 实例规格的 vCPU 内核数目。取值参见实例规格族。 当 DestinationResource 取值为 InstanceType 时,Cores 才为有效参数。 | 2 |
Memory | float | 否 | 实例规格的内存大小,单位为 GiB。取值参见实例规格族。 当 DestinationResource 取值为 InstanceType 时,Memory 才为有效参数。 | 8.0 |
ResourceType | string | 否 | 资源类型。取值范围:
| instance |
Scope | string | 否 | 预留实例券的范围。取值范围:
| Region |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0041D94C-FB92-4C49-B115-259DA1C*****",
"AvailableZones": {
"AvailableZone": [
{
"ZoneId": "cn-hangzhou-e",
"Status": "Available",
"StatusCategory": "WithStock",
"RegionId": "cn-hangzhou",
"AvailableResources": {
"AvailableResource": [
{
"Type": "InstanceType",
"SupportedResources": {
"SupportedResource": [
{
"Status": "Available",
"Value": "ecs.d1ne.xlarge",
"Max": 2048,
"Unit": "GiB",
"StatusCategory": "WithStock",
"Min": 20
}
]
}
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid.InstanceChargeType | The specified InstanceChargeType is not valid. | 指定的参数 InstanceChargeType 无效。 |
400 | Invalid.Param | The input parameter DestinationResource that is mandatory for processing this request is not supplied. | 目标资源类型无效。 |
400 | InvalidRegionId.MalFormed | The specified parameter RegionId is not valid. | 指定的 RegionId 不合法。 |
403 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist. | 指定的专有宿主机不存在。 |
403 | InvalidParam.TypeAndCpuMem.Conflict | The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time. | 不能同时指定规格、核数和内存 |
403 | InvalidParam.Cores | The specified parameter 'Cores' should be empty | - |
403 | InvalidParam.Memory | The specified parameter 'Memory' should be empty | - |
403 | InvalidParameter.Scope | The specified parameter Scope is invalid. | - |
403 | OperationDenied.RegionIdNotSupported | region not support spot duration instance. | - |
403 | OperationDenied.FlavorNotSupported | flavor not support spot duration instance. | - |
403 | OperationDenied.TimestampNotSupported | timestamp not support spot duration instance. | - |
403 | InvalidParameter.ResourceOwnerId | The specified parameter ResourceOwnerId is not available anymore. | - |
404 | Invalid.RegionId | The specified RegionId does not exist. | 地域参数无效。 |
404 | Unavailable.Regions | The available regions does not exists | 地域参数无效。 |
404 | Invalid.ResourceType | The ResourceType provided does not exist in our records. | 资源类型无效。 |
404 | Invalid.DestinationResource | The specified DestinationResource is not valid. | 指定的目标资源无效。 |
404 | Invalid.IoOptimized | The specified IoOptimized is not valid. | 指定的参数 IoOptimized 无效。 |
404 | Invalid.NetworkCategory | The specified NetworkCategory is not valid. | 指定的参数 NetworkCategory 无效。 |
404 | Invalid.SpotStrategy | The specified SpotStrategy is not valid. | 竞价策略参数无效。 |
404 | Invalid.NetworkType | The specified NetworkType is not valid. | 指定的参数 NetworkType 无效。 |
404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records | 指定的参数 ResourceId 无效,请确认该资源是否存在。 |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-25 | OpenAPI 错误码发生变更 | 查看变更详情 |