You need to enable JavaScript to run this app.
导航
DescribeAvailableResource - 查询可用区资源
最近更新时间:2024.05.21 10:23:55首次发布时间:2021.10.31 07:37:16

调用 DescribeAvailableResource 接口查询可用区中计算资源的库存信息,包括所属地域、可用区、计算资源库存状态等。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeAvailableResource

要执行的操作,取值:DescribeAvailableResource。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

DestinationResource
String

InstanceType

要查询的资源类型。取值:

  • InstanceType:实例规格。
  • VolumeType:云盘类型。
  • DedicatedHost:专有宿主机规格。
    专有宿主机规格请参见规格介绍
ElasticScheduledInstanceType
String

NoEsi

弹性预约实例类型,取值:

  • NoEsi(默认):非弹性预约实例。
  • Esi:弹性预约实例。
  • Segmented:弹性预约实例-时段型。

说明

  • 当参数InstanceChargeType取值为PostPaid时生效。
  • 弹性预约实例正在邀测中,如需试用,请联系客户经理申请。
InstanceChargeType
String

PostPaid

资源的计费类型。取值:

  • PostPaid:按量计费。
  • PrePaid:包年包月。
  • ReservedInstance:预留实例券。
InstanceTypeId
String

ecs.g3i.large

指定一个要查询的实例规格或专有宿主机规格。

SpotStrategy
String

NoSpot

按量计费的抢占式策略,取值:

  • NoSpot(默认):正常按量计费实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

说明

InstanceChargeType取值为PostPaid时,该参数生效。

VolumeType
String

ESSD_PL0

指定一个要查询的云盘类型,取值:

  • ESSD_PL0:极速型SSD PL0
  • ESSD_FlexPL:极速型SSD FlexPL
ZoneId
String

cn-beijing-a

可用区ID,您可以调用DescribeZones查询一个地域下的可用区信息。

说明

默认为空,表示返回当前地域(RegionId)下的所有可用区中所有符合条件的资源。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
AvailableZones
Array of AvailableZonesForDescribeAvailableResource

--

可用区中符合条件的资源的信息。

请求示例

GET /?Action=DescribeAvailableResource&Version=2020-04-01&DestinationResource=InstanceType&ZoneId=cn-*****&InstanceTypeId=ecs.g2i.large HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeAvailableResource",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "AvailableZones": [{
            "AvailableResources": [{
                "SupportedResources": [{
                    "Status": "Available",
                    "Value": "ecs.g2i.large"
                }],
                "Type": "InstanceType"
             }],
             "RegionId": "cn-beijing",
             "Status": "Available",
             "ZoneId": "cn-beijing-a"
        }]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidDestinationResource
The specified DestinationResource is not valid, is unsupported, or cannot be used.

指定的目标资源类不合法。

400
InvalidElasticScheduledInstanceType.Malformed
The specified ElasticScheduledInstanceType is malformed.

指定的弹性预约实例类型不合法。

400
InvalidInstanceChargeType
The specified InstanceChargeType is invalid.

指定的实例计费类型不合法。

400
InvalidSpotStrategy
The specified SpotStrategy is invalid.

指定的实例抢占策略不合法。

400
InvalidVolumeType.Malformed
The specified VolumeType is malformed.

指定的云盘类型不合法。

400
MissingParameter.DestinationResource
The required parameter DestinationResource is not supplied.

目标资源类型为空。

404
InvalidInstanceType.NotFound
The specified InstanceType does not exist.

指定的实例规格不存在。

404
InvalidZone.NotFound
The specified zone does not exist.

指定的可用区不存在。

500
InternalError
An internal error has occurred.

内部错误,请重试。如果多次尝试失败,请提交工单。