调用 DescribeAvailableResource 接口查询可用区中计算资源的库存信息,包括所属地域、可用区、计算资源库存状态等。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAvailableResource | 要执行的操作,取值:DescribeAvailableResource。 |
Version | String | 是 | 2020-04-01 | API的版本,取值:2020-04-01。 |
DestinationResource | String | 是 | InstanceType | 要查询的资源类型。取值:
|
ElasticScheduledInstanceType | String | 否 | NoEsi | 弹性预约实例类型,取值:
说明
|
InstanceChargeType | String | 否 | PostPaid | 资源的计费类型。取值:
|
InstanceTypeId | String | 否 | ecs.g3i.large | 指定一个要查询的实例规格或专有宿主机规格。 |
SpotStrategy | String | 否 | NoSpot | 按量计费的抢占式策略,取值:
说明 当 |
VolumeType | String | 否 | ESSD_PL0 | 指定一个要查询的云盘类型,取值:
|
ZoneId | String | 否 | cn-beijing-a | 可用区ID,您可以调用DescribeZones查询一个地域下的可用区信息。 说明 默认为空,表示返回当前地域(RegionId)下的所有可用区中所有符合条件的资源。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AvailableZones | Array of Object | -- | 可用区中符合条件的资源的信息。 |
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 | 指定的目标资源类不合法。 |
400 | InvalidElasticScheduledInstanceType.Malformed | 指定的弹性预约实例类型不合法。 |
400 | InvalidInstanceChargeType | 指定的实例计费类型不合法。 |
400 | InvalidSpotStrategy | 指定的实例抢占策略不合法。 |
400 | InvalidVolumeType.Malformed | 指定的云盘类型不合法。 |
400 | MissingParameter.DestinationResource | 目标资源类型为空。 |
404 | InvalidInstanceType.NotFound | 指定的实例规格不存在。 |
404 | InvalidZone.NotFound | 指定的可用区不存在。 |
500 | InternalError | 内部错误,请重试。如果多次尝试失败,请提交工单。 |