通过DescribeAvailableResource可以查询指定地域和可用区下可售ECS实例规格族。

接口说明

调用CreateContainerGroup创建ECI实例时支持通过InstanceType参数来指定ECS规格,以满足特定的规格需求。为保证ECI实例能够创建成功,在创建ECI实例前,您可以先调用本接口查询指定地域和可用区下支持哪些ECS实例规格或实例规格族。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAvailableResource

系统规定参数。取值:DescribeAvailableResource

RegionId String cn-hangzhou

地域ID。

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

ZoneId String cn-hangzhou-e

可用区ID。

默认值为空,此时查询指定地域下的所有可用区。

DestinationResource Object

要查询的资源信息。

Category String InstanceTypeFamily

资源类型。取值范围:

  • InstanceTypeFamily:表示查询实例规格族,配合Value使用。
  • InstanceType:表示查询实例规格,配合Value,以及Cores和Memory使用。
Value String ecs.c6

实例规格族或者具体实例规格。

  • 当Category取值为InstanceTypeFamily时,取值为实例规格族,如ecs.c5。
  • 当Category取值为InstanceType时,取值为具体实例规格。如ecs.c5.large。
Cores Float 2

vCPU核数。当Category取值为InstanceType时,可以设置。

Memory Float 4

内存大小。单位为GiB。当Category取值为InstanceType时,可以设置。

SpotResource Object

要查询的抢占式实例的资源信息。

SpotStrategy String SpotAsPriceGo

实例的抢占策略。取值范围:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

默认为:NoSpot。

说明 查询抢占式实例资源信息时,即取值为SpotWithPriceLimit或SpotAsPriceGo时,Category取值必须为InstanceType,同时需指定具体实例规格(Value),或者指定vCPU和内存(Cores和Memory)。
SpotPriceLimit double 0.2

抢占式实例的每小时最高价格,最多精确到小数点后3位。当SpotStrategy取值为SpotWithPriceLimit时,必须设置SpotPriceLimit。

SpotDuration Integer 1

抢占式实例的保护期。单位为小时。取值范围为0~6,默认为1。

返回数据

名称 类型 示例值 描述
RequestId String 6829735A-FF76-58C6-AECB-27CBF135A7AA

请求ID。

AvailableZones Array of AvailableZone

可用区级别的资源信息集合。

AvailableZone
RegionId String cn-hangzhou

地域ID。

ZoneId String cn-hangzhou-e

可用区ID。

AvailableResources Array of AvailableResource

该可用区支持的资源信息集合。

AvailableResource
Type String InstanceTypeFamily

资源类型。可能值:

  • InstanceTypeFamily:表示实例规格族。
  • InstanceType:表示实例规格。
SupportedResources Array of SupportedResource

资源信息组成的数组。

SupportedResource
Value String ecs.c6

支持的ECS实例规格信息。

  • 当Type为InstanceTypeFamily时,Value值为实例规格族。
  • 当Type为InstanceType时,Value值为实例规格。
StatusCategory String WithStock

根据库存详细分类资源类别。可能值:

  • WithStock:库存充足。
  • ClosedWithStock:库存供应保障能力低,建议选用WithStock状态的实例规格。
  • WithoutStock:库存售罄,将会补充资源,建议选用WithStock状态的实例规格。
  • ClosedWithoutStock:库存售罄,且不补充资源,请选用WithStock状态的实例规格。

示例

请求示例

https://eci.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-e
&DestinationResource={"Category":"InstanceTypeFamily"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAvailableResourceResponse>
    <RequestId>6829735A-FF76-58C6-AECB-27CBF135A7AA</RequestId>
    <AvailableZones>
        <RegionId>cn-hangzhou</RegionId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <AvailableResources>
            <Type>InstanceTypeFamily</Type>
            <SupportedResources>
                <Value>ecs.c6</Value>
                <StatusCategory>WithStock</StatusCategory>
            </SupportedResources>
        </AvailableResources>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6829735A-FF76-58C6-AECB-27CBF135A7AA",
  "AvailableZones" : [ {
    "RegionId" : "cn-hangzhou",
    "ZoneId" : "cn-hangzhou-e",
    "AvailableResources" : [ {
      "Type" : "InstanceTypeFamily",
      "SupportedResources" : [ {
        "Value" : "ecs.c6",
        "StatusCategory" : "WithStock"
      } ]
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。