DescribeAvailableResource_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

  • 取值示例:

    • 若参数DestinationResource取值为DataDisk

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

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

    • 若参数DestinationResource取值为SystemDiskResourceType取值为instance,由于 ECS 实例规格对系统盘存在限制,则必须要传入参数InstanceType

    • 若参数DestinationResource取值为InstanceType,建议传入参数IoOptimizedInstanceType

    • 查询指定地域下所有可用区的 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"

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceChargeTypestring

资源的计费方式。更多信息,请参见计费概述。取值范围: 展开详情

示例值:PrePaid参考取值来源:
    DescribeInstances
SpotStrategystring

按量付费实例的竞价策略。取值范围: 展开详情

示例值:NoSpot
SpotDurationinteger<int32>

抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:展开详情

示例值:1取值 <= 6
DestinationResourcestring

要查询的资源类型。取值范围: 展开详情

示例值:InstanceType
ZoneIdstring

可用区 ID。展开详情

示例值:cn-hangzhou-e参考取值来源:
    DescribeZones
IoOptimizedstring

是否为 I/O 优化实例。取值范围: 展开详情

示例值:optimized
DedicatedHostIdstring

专有宿主机 ID。

示例值:dh-bp165p6xk2tlw61e****参考取值来源:
    AllocateDedicatedHosts
    DescribeDedicatedHosts
InstanceTypestring

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

示例值:ecs.g5.large参考取值来源:
    DescribeInstanceTypes
    CreateInstance
SystemDiskCategorystring

系统盘类型。取值范围: 展开详情

示例值:cloud_ssd
DataDiskCategorystring

数据盘类型。取值范围: 展开详情

示例值:cloud_ssd
NetworkCategorystring

网络类型。取值范围: 展开详情

示例值:vpc
Coresinteger<int32>

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

示例值:2
Memorynumber<float>

实例规格的内存大小,单位为 GiB。取值参见实例规格族展开详情

示例值:8.0
ResourceTypestring

资源类型。取值范围:展开详情

示例值:instance参考取值来源:
    TagResources
Scopestring

预留实例券的范围。取值范围:展开详情

示例值:Region

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:0041D94C-FB92-4C49-B115-259DA1C*****
AvailableZonesobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Invalid.InstanceChargeType
The specified InstanceChargeType is not valid.诊断
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.诊断
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
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.诊断
404
Invalid.NetworkCategory
The specified NetworkCategory is not valid.诊断
404
Invalid.SpotStrategy
The specified SpotStrategy is not valid.诊断
404
Invalid.NetworkType
The specified NetworkType is not valid.诊断
404
InvalidResourceId.NotFound
The specified ResourceId is not found in our records.诊断
404
InvalidRegionId.NotFound
The RegionId provided does not exist in our records.诊断

变更历史

变更时间变更内容概要操作
2025-02-27
变更错误码403
变更错误码404
2024-03-25
变更请求参数SpotDuration

相关示例

调用DescribeAvailableResource查询某一可用区的资源列表。您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源列表。
2024-04-03
本文介绍如何通过阿里云ECS SDK调用DescribeZones、DescribeAvailableResource查询某一地域下有库存的抢占式实例规格。
2024-07-30