AI 助理
文档备案控制台
官方文档
首页

DescribeAvailableResource - 查询可用区的资源库存

更新时间：
复制 MD 格式
产品详情
我的收藏

查询指定可用区的资源库存状态。该接口主要用于在创建实例（RunInstances）或修改实例规格（ModifyInstanceSpec）前，确认目标资源（如实例规格、系统盘类型）在特定可用区是否库存充足。

接口说明

参数DestinationResource的取值有不同的逻辑与要求。在下列的顺序列表中，顺序越低的取值需要设置更多的参数，不支持通过低顺序的取值筛选高顺序的资源类别。

  • 取值顺序：Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk

  • 取值示例：

    • 若参数DestinationResource取值为DataDisk：

      • ResourceType取值为disk表示查询与 ECS 实例规格无关的数据盘类型，可以不传入参数InstanceType。

      • ResourceType取值为instance表示查询待挂载至 ECS 实例的数据盘类型，由于实例规格对数据盘有限制，所以需要同时指定InstanceType与参数DataDiskCategory 。

    • 若参数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。

查询杭州地域供应实例规格为 ecs.g5.large 的可用区列表。

"RegionId": "cn-hangzhou",
"DestinationResource": "Zone"，
"InstanceType": "ecs.g5.large"

查询杭州地域、所有可用区下的实例类型为 ecs.g5.large 的库存。

"RegionId": "cn-hangzhou",
"DestinationResource": "InstanceType"，
"InstanceType": "ecs.g5.large"

【只购买数据盘】查询杭州地域、可用区 b 下的数据盘类型为 cloud_efficiency 的库存。

"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-b",
"ResourceType": "disk",
"DestinationResource": "DataDisk"

【购买 ECS 实例和系统盘】查询杭州地域、可用区 b 下的实例类型为 ecs.g7.large、系统盘类型为 cloud_essd 的库存。

"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-b",
"ResourceType": "instance",
"InstanceType": "ecs.g7.large",
"DestinationResource": "SystemDisk",
"SystemDiskCategory": "cloud_essd"

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

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

cn-hangzhou
InstanceChargeType

string

否

资源的计费方式。更多信息，请参见计费概述。取值范围：

  • PrePaid：包年包月。

  • PostPaid：按量付费。

默认值：PostPaid。

PrePaid
SpotStrategy

string

否

按量付费实例的竞价策略。取值范围：

  • NoSpot：正常按量付费实例。

  • SpotWithPriceLimit：设置上限价格的抢占式实例。

  • SpotAsPriceGo：系统自动出价，最高按量付费价格。

默认值：NoSpot。

当参数InstanceChargeType取值为PostPaid时，参数SpotStrategy才有效。

NoSpot
SpotDuration

integer

否

抢占式实例的保留时长，单位为小时。 默认值：1。取值范围：

  • 1：创建后阿里云会保证实例运行 1 小时不会被自动释放；超过 1 小时后，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。

  • 0：创建后，阿里云不保证实例运行 1 小时，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费，建议您结合具体任务执行耗时来选择合适的保留时长。

说明

当InstanceChargeType取值为PostPaid，并且SpotStrategy值为SpotWithPriceLimit或SpotAsPriceGo时该参数生效。

1
DestinationResource

string

是

要查询的资源类型。取值范围：

  • Zone：可用区。

  • IoOptimized：I/O 优化。

  • InstanceType：实例规格。

  • Network：网络类型。

  • ddh：专有宿主机。

  • SystemDisk：系统盘。

  • DataDisk：数据盘。

说明

当 DestinationResource 取值为SystemDisk时，由于系统盘受实例规格限制，此时必须传入 InstanceType。

参数 DestinationResource 的取值方式请参见本文中的接口说明。

InstanceType
ZoneId

string

否

可用区 ID。

默认值：无。返回该地域（RegionId）下所有可用区符合查询条件的资源。

cn-hangzhou-e
IoOptimized

string

否

是否为 I/O 优化实例。取值范围：

  • none：非 I/O 优化实例。

  • optimized：I/O 优化实例。

默认值：optimized。

optimized
DedicatedHostId

string

否

专有宿主机 ID。

dh-bp165p6xk2tlw61e****
InstanceType

string

否

实例规格。更多信息，请参见实例规格族，您也可以调用 DescribeInstanceTypes 接口获得最新的规格表。

参数 InstanceType 的取值方式请参见本文开头的接口说明。

ecs.g5.large
SystemDiskCategory

string

否

系统盘类型。取值范围：

  • cloud：普通云盘。

  • cloud_efficiency：高效云盘。

  • cloud_ssd：SSD 云盘。

  • ephemeral_ssd：本地 SSD 盘。

  • cloud_essd：ESSD 云盘。

  • cloud_auto：ESSD AutoPL 云盘。

  • cloud_essd_entry：ESSD Entry 云盘。

参数默认值说明：

  • 当 InstanceType 为已停售的实例规格，该参数默认值为cloud。

  • 其它情况下，该参数默认值为cloud_efficiency。2026 年 1 月 30 日后，对于仅支持 cloud_essd 的实例规格，默认值由 cloud_efficiency 调整为 cloud_essd PL0，详情参见变更公告。

说明

参数 ResourceType 取值为 instance、DestinationResource 取值为 DataDisk 时，参数 SystemDiskCategory 是必选参数。如果未传递参数值，则以默认值生效。

cloud_ssd
DataDiskCategory

string

否

数据盘类型。取值范围：

  • cloud：普通云盘。

  • cloud_efficiency：高效云盘。

  • cloud_ssd：SSD 云盘。

  • ephemeral_ssd：本地 SSD 盘。

  • cloud_essd：ESSD 云盘。

  • cloud_auto：ESSD AutoPL 云盘。

  • cloud_essd_entry：ESSD Entry 云盘。

cloud_ssd
NetworkCategory

string

否

网络类型。取值范围：

  • vpc：专有网络。

  • classic：经典网络。经典网络功能已下线，详情请参见下线公告。

vpc
Cores

integer

否

实例规格的 vCPU 内核数目。取值参见实例规格族。

当 DestinationResource 取值为 InstanceType 时，Cores 才为有效参数。

2
Memory

number

否

实例规格的内存大小，单位为 GiB。取值参见实例规格族。

当 DestinationResource 取值为 InstanceType 时，Memory 才为有效参数。

8.0
ResourceType

string

否

资源类型。取值范围：

  • instance：ECS 实例。

  • disk：云盘。

  • reservedinstance：预留实例券。

  • ddh：专有宿主机。

instance
Scope

string

否

预留实例券的范围。取值范围：

  • Region：地域级别。

  • Zone：可用区级别。

Region

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0041D94C-FB92-4C49-B115-259DA1C*****
AvailableZones

object

AvailableZone

array<object>

可用区库存信息的集合。

array<object>

可用区库存信息。

ZoneId

string

可用区 ID。

cn-hangzhou-e
Status

string

可用区的状态描述。可能值：

  • Available：资源可售 ，代表该可用区有可售的任意资源，不仅指待查询的某一种资源。

  • SoldOut：资源已售罄，代表该可用区下已没有可售卖的任何资源。

Available
StatusCategory

string

根据可用区下库存情况对可用区状态进行详细描述。可能值：

  • WithStock：当前有库存，且会持续补充资源。

  • ClosedWithStock：当前有库存，但不会继续补充资源。

  • WithoutStock：库存售罄，将会补充资源，建议选用 WithStock 状态的产品规格。

  • ClosedWithoutStock：库存售罄，且不补充资源，请选用 WithStock 状态的产品规格。

WithStock
RegionId

string

地域 ID。

cn-hangzhou
AvailableResources

object

AvailableResource

array<object>

可供创建的具体资源组成的数组。

array<object>

可供创建的具体资源集合。

Type

string

资源类型。可能值：

  • Zone：可用区。

  • IoOptimized：I/O 优化。

  • InstanceType：实例规格。

  • SystemDisk：系统盘。

  • DataDisk：数据盘。

  • Network：网络类型。

  • ddh：专有宿主机。

InstanceType
SupportedResources

object

SupportedResource

array<object>

支持的可供创建的具体资源组成的数组。

object

支持的可供创建的具体资源信息。

Status

string

具体资源类型的状态描述。可能值：

  • Available：资源可售。

  • SoldOut：资源已售罄。

Available
Value

string

资源值。

ecs.d1ne.xlarge
Max

integer

云盘容量范围的最大值。

说明

仅当入参 DestinationResource 取值为SystemDisk或DataDisk时该参数才生效。

2048
Unit

string

云盘容量的单位。

说明

仅当入参 DestinationResource 取值为SystemDisk或DataDisk时该参数才生效。

GiB
StatusCategory

string

根据库存情况对资源状态进行详细描述。可能值：

  • WithStock：当前有库存，且会持续补充资源。

  • ClosedWithStock：当前有库存，但不会继续补充资源。

  • WithoutStock：库存售罄，将会补充资源，建议选用 WithStock 状态的产品规格。

  • ClosedWithoutStock：库存售罄，且不补充资源，请选用 WithStock 状态的产品规格。

WithStock
Min

integer

云盘容量范围的最小值。

说明

仅当入参 DestinationResource 取值为SystemDisk或DataDisk时该参数才生效。

20

示例

正常返回示例

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. 指定的参数“Cores”应为空。
403 InvalidParam.Memory The specified parameter 'Memory' should be empty. 指定的参数“Memory”应为空。
403 InvalidParameter.Scope The specified parameter Scope is invalid. 指定的参数Scope无效。
403 OperationDenied.RegionIdNotSupported The region does not support preemptible instances.
403 OperationDenied.FlavorNotSupported The flavor does not support preemptible instances.
403 OperationDenied.TimestampNotSupported Preemptible instances are not for sale for current time.
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 region does not exist.
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. 指定的资源不存在，请您检查该资源是否正确。
404 InvalidRegionId.NotFound The RegionId provided does not exist in our records. 地域信息错误
404 InvalidDedicatedHostId.NotFound The specified Dedicated Host does not exist. 指定的专有宿主机不存在。

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeZones - 查询可用区列表下一篇：DescribeAccountAttributes - 查询资源配额