You need to enable JavaScript to run this app.
导航

DescribeAvailableResource

最近更新时间2024.01.12 08:03:58

首次发布时间2021.10.31 07:37:16

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

调试

请求参数

名称类型是否必填示例值
描述
ActionStringDescribeAvailableResource要执行的操作,取值:DescribeAvailableResource。
VersionString2020-04-01API的版本,取值:2020-04-01。

DestinationResource

String

InstanceType

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

  • InstanceType:实例规格。

  • VolumeType:云盘类型。

  • DedicatedHost:专有宿主机规格。

    说明

    专有宿主机规格请参见规格介绍。该功能正在邀测中,如需试用,请提交工单或联系客户经理申请。

ZoneId

String

cn-beijing-a

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

说明

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

InstanceTypeIdStringecs.g2i.large指定一个要查询的资源规格。

InstanceChargeType

String

PostPaid

资源的计费类型,取值:

  • PostPaid(默认):按量计费

  • PrePaid:包年包月

  • ReservedInstance:预留实例券

SpotStrategy

String

NoSpot

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

  • NoSpot(默认):正常按量计费实例。

  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

说明

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

VolumeType

String

ESSD_PL0

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

  • ESSD_PL0:极速型SSD PL0

  • ESSD_FlexPL:极速型SSD FlexPL

ElasticScheduledInstanceType

String

NoEsi

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

  • NoEsi(默认):非弹性预约实例。

  • Esi:弹性预约实例。

  • Segmented:弹性预约实例-时段型。

说明

  • 当参数InstanceChargeType取值为PostPaid时生效。

  • 弹性预约实例正在邀测中,如需试用,请提交工单或联系客户经理申请。

返回数据

名称类型示例值
描述
AvailableZonesArray of Struct-可用区中符合条件的资源的信息,具体请参见下表“ AvailableZones 结构 ”。

AvailableZones 结构

名称类型
示例值
描述
StatusStringAvailable可用区的资源库存状态,取值:
  • Available:资源充足
  • SoldOut:资源已售罄
  • RegionIdStringcn-beijing可用区所属地域ID。
    ZoneIdStringcn-beijing-a可用区ID。
    AvailableResourcesArray of Struct-可用区中各资源的具体信息,具体请参见下表“ AvailableResources 结构 ”。

    AvailableResources 结构

    名称类型示例值
    描述
    TypeStringInstanceType资源的类型。
    SupportedResourcesArray of Struct-资源的具体信息,具体请参见下表“ SupportedResources 结构 ”。
    SupportedResources 结构
    名称类型示例值
    描述
    StatusStringAvailable资源的库存状态,取值:
  • Available:资源充足
  • SoldOut:资源已售罄
  • ValueStringecs.g2i.large资源的取值。

    请求示例

    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"
            }]
        }
    }
    

    错误码

    HttpCode错误码错误信息描述
    400InvalidDestinationResourceThe specified DestinationResource is not valid, is unsupported, or cannot be used.指定的目标资源类不合法。
    400MissingParameter.DestinationResourceThe required parameter DestinationResource is not supplied.目标资源类型为空。
    400InvalidInstanceChargeTypeThe specified InstanceChargeType is invalid.指定的实例计费类型不合法。
    400InvalidSpotStrategyThe specified SpotStrategy is invalid.指定的实例抢占策略不合法。
    400InvalidVolumeType.MalformedThe specified VolumeType is malformed.指定的云盘类型不合法。
    400InvalidElasticScheduledInstanceType.MalformedThe specified ElasticScheduledInstanceType is malformed.指定的弹性预约实例类型不合法。
    404InvalidZone.NotFoundThe specified zone does not exist.指定的可用区不存在。
    404InvalidInstanceType.NotFoundThe specified InstanceType does not exist.指定的实例规格不存在。
    500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。