DescribeAvailableResource - 查询可用ECS实例规格 - 弹性容器实例

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。	cn-hangzhou
ZoneId	string	否	可用区ID。默认值为空，此时查询指定地域下的所有可用区。	cn-hangzhou-e
DestinationResource	object	是	要查询的资源信息。
Category	string	是	资源类型。取值范围： InstanceTypeFamily：表示查询实例规格族，配合Value使用。 InstanceType：表示查询实例规格，配合Value，以及Cores和Memory使用。	InstanceTypeFamily
Value	string	否	实例规格族或者具体实例规格。当Category取值为InstanceTypeFamily时，取值为实例规格族，如ecs.c5。当Category取值为InstanceType时，取值为具体实例规格。如ecs.c5.large。	ecs.c6
Cores	float	否	vCPU核数。当Category取值为InstanceType时，可以设置。	2
Memory	float	否	内存大小。单位为GiB。当Category取值为InstanceType时，可以设置。	4
SpotResource	object	否	要查询的抢占式实例的资源信息。
SpotStrategy	string	否	实例的抢占策略。取值范围： NoSpot：正常按量付费实例。 SpotWithPriceLimit：设置上限价格的抢占式实例。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。默认为：NoSpot。说明查询抢占式实例资源信息时，即取值为SpotWithPriceLimit或SpotAsPriceGo时，Category取值必须为InstanceType，同时需指定具体实例规格（Value），或者指定vCPU和内存（Cores和Memory）。	SpotAsPriceGo
SpotPriceLimit	double	否	抢占式实例的每小时最高价格，最多精确到小数点后3位。当SpotStrategy取值为SpotWithPriceLimit时，必须设置SpotPriceLimit。	0.2
SpotDuration	integer	否	抢占式实例的保护期。单位为小时。默认为1。可设置为0，表示无保护期。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求ID。	6829735A-FF76-58C6-AECB-27CBF135A7AA
AvailableZones	array	可用区级别的资源信息集合。
	object
RegionId	string	地域ID。	cn-hangzhou
ZoneId	string	可用区ID。	cn-hangzhou-e
AvailableResources	array	该可用区支持的资源信息集合。
	object
Type	string	资源类型。可能值： InstanceTypeFamily：表示实例规格族。 InstanceType：表示实例规格。	InstanceTypeFamily
SupportedResources	array	资源信息组成的数组。
	object
Value	string	支持的ECS实例规格信息。当Type为InstanceTypeFamily时，Value值为实例规格族。当Type为InstanceType时，Value值为实例规格。	ecs.c6
StatusCategory	string	根据库存详细分类资源类别。可能值： WithStock：库存充足。 ClosedWithStock：库存供应保障能力低，建议选用WithStock状态的实例规格。 WithoutStock：库存售罄，将会补充资源，建议选用WithStock状态的实例规格。 ClosedWithoutStock：库存售罄，且不补充资源，请选用WithStock状态的实例规格。	WithStock

示例

正常返回示例

JSON格式

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

错误码

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