调用DescribeAvailableResource查询某一可用区的资源列表。您可以在某一可用区创建实例(RunInstances)或者修改实例规格(ModifyInstanceSpec)时查询该可用区的资源列表。
接口说明
参数DestinationResource
的取值有不同的逻辑与要求。在下列的顺序列表中,顺序越低的取值需要设置更多的参数,不支持通过低顺序的取值筛选高顺序的资源类别。
- 取值顺序:
Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk
- 取值示例:
- 若参数
DestinationResource
取值为DataDisk
,则需要传入InstanceType
参数或者指定ResourceType
参数值为disk
。 - 若参数
DestinationResource
取值为SystemDisk
,则必须要传入参数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代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAvailableResource | 系统规定参数。取值:DescribeAvailableResource |
DestinationResource | String | 是 | InstanceType | 要查询的资源类型。取值范围:
参数DestinationResource的取值方式请参见上文接口说明。 |
RegionId | String | 是 | cn-hangzhou | 目标地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ZoneId | String | 否 | cn-hangzhou-e | 可用区ID。 默认值:无,表示随机分配当前地域下的可用区,返回该地域( |
InstanceChargeType | String | 否 | PrePaid | 资源的计费方式。更多详情,请参见计费概述。取值范围:
默认值:PostPaid |
SpotStrategy | String | 否 | NoSpot | 按量付费实例的抢占策略。取值范围:
默认值:NoSpot 当参数InstanceChargeType取值为PostPaid时,参数SpotStrategy才有效。 |
IoOptimized | String | 否 | optimized | 是否为I/O优化实例。取值范围:
默认值:optimized |
DedicatedHostId | String | 否 | dh-bp165p6xk2tlw61e**** | 专有宿主机ID。 |
InstanceType | String | 否 | ecs.g5.large | 实例规格。更多详情,请参见实例规格族,也可以调用DescribeInstanceTypes接口获得最新的规格表。 当参数DestinationResource取值为SystemDisk或者DataDisk时,InstanceType为必需参数。 |
SystemDiskCategory | String | 否 | cloud_ssd | 系统盘类型。取值范围:
若参数DestinationResource取值为SystemDisk、InstanceType或者DataDisk时,参数SystemDiskCategory不是必需参数。 默认值:cloud_efficiency |
DataDiskCategory | String | 否 | cloud_ssd | 数据盘类型。取值范围:
|
NetworkCategory | String | 否 | vpc | 网络类型。取值范围:
|
Cores | Integer | 否 | 2 | 实例规格的vCPU内核数目。取值参见实例规格族。 当DestinationResource取值为InstanceType时,Cores才为有效参数。 |
Memory | Float | 否 | 8.0 | 实例规格的内存大小,单位为GiB。取值参见实例规格族。 当DestinationResource取值为InstanceType时,Memory才为有效参数。 |
ResourceType | String | 否 | instance | 资源类型。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AvailableZones | Array of AvailableZone | 库存信息组成的集合。 |
|
AvailableZone | |||
AvailableResources | Array of AvailableResource | 可供创建的具体资源组成的数组。 |
|
AvailableResource | |||
SupportedResources | Array of SupportedResource | 支持的可供创建的具体资源组成的数组。 |
|
SupportedResource | |||
Max | Integer | 2 | 资源规格的最大值,该参数值为空时将不返回。 |
Min | Integer | 1 | 资源规格的最小值,该参数值为空时将不返回。 |
Status | String | Available | 资源状态。可能值:
|
StatusCategory | String | WithStock | 根据库存详细分类资源类别。可能值:
|
Unit | String | null | 资源规格单位,该参数值为空时将不返回。 |
Value | String | ecs.d1ne.xlarge | 资源值。 |
Type | String | InstanceType | 资源类型。可能值:
|
RegionId | String | cn-hangzhou | 地域ID。 |
Status | String | Available | 资源状态。可能值:
|
StatusCategory | String | WithStock | 根据库存详细分类资源类别。可能值:
|
ZoneId | String | cn-hangzhou-e | 可用区ID。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeAvailableResource &RegionId=cn-hangzhou &DestinationResource=InstanceType &IoOptimized=optimized &InstanceType=ecs.g5.large &<公共请求参数>
正常返回示例
XML
格式
<DescribeAvailableResourceResponse> <RequestId>0041D94C-FB92-4C49-B115-259DA1CE1923</RequestId> <AvailableZones> <AvailableZone> <Status>Available</Status> <RegionId>cn-hangzhou</RegionId> <AvailableResources> <AvailableResource> <Type>InstanceType</Type> <SupportedResources> <SupportedResource> <Status>Available</Status> <Value>ecs.g5.large</Value> <StatusCategory>WithStock</StatusCategory> </SupportedResource> </SupportedResources> </AvailableResource> </AvailableResources> <ZoneId>cn-hangzhou-i</ZoneId> <StatusCategory>WithStock</StatusCategory> </AvailableZone> </AvailableZones> </DescribeAvailableResourceResponse>
JSON
格式
{ "RequestId": "0041D94C-FB92-4C49-B115-259DA1CE1923", "AvailableZones": { "AvailableZone": [ { "Status": "Available", "RegionId": "cn-hangzhou", "AvailableResources": { "AvailableResource": [ { "Type": "InstanceType", "SupportedResources": { "SupportedResource": [ { "Status": "Available", "Value": "ecs.g5.large", "StatusCategory": "WithStock" } ] } } ] }, "ZoneId": "cn-hangzhou-i", "StatusCategory": "WithStock" } ] } }
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | Invalid.RegionId | The specified RegionId does not exist. | 地域参数无效。 |
404 | Unavailable.Regions | The available regions does not exists | 地域参数无效。 |
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. | 目标资源类型无效。 |
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. | 竞价策略参数无效。 |
403 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist. | 指定的专有宿主机不存在。 |
404 | Invalid.NetworkType | The specified NetworkType is not valid. | 指定的参数NetworkType无效。 |
404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records | 指定的参数ResourceId无效,请确认该资源是否存在。 |
403 | InvalidParam.TypeAndCpuMem.Conflict | The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time. | 参数“InstanceType”、“Cores”、“Memory”不能同时为空。 |
403 | InvalidParam.Cores | The specified parameter 'Cores' should be empty | 指定的参数“Cores”应该为空。 |
403 | InvalidParam.Memory | The specified parameter 'Memory' should be empty | 指定的参数“Memory”应为空。 |
400 | InvalidRegionId.MalFormed | The specified parameter RegionId is not valid. | 指定的RegionId不合法。 |
访问错误中心查看更多错误码。