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>	可用区级别的资源信息集合。
AvailableZone	object
RegionId	string	地域 ID。	cn-hangzhou
ZoneId	string	可用区 ID。	cn-hangzhou-e
AvailableResources	array<object>	该可用区支持的资源信息集合。
AvailableResource	object
Type	string	资源类型。可能值： InstanceTypeFamily：表示实例规格族。 InstanceType：表示实例规格。	InstanceTypeFamily
SupportedResources	array<object>	资源信息组成的数组。
SupportedResource	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"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	%s	必填参数缺失
400	InvalidParameter	%s	不合法的参数
403	Spot.NotMatched	%s. We recommend that you use the create multi-zone function to avoid insufficient inventory.	推荐使用多可用区多规格配置来避免库存不足
404	InvalidParameter.NotFound	%s	参数未找到

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

变更历史

变更时间	变更内容概要	操作
2024-06-21	OpenAPI 错误码发生变更	查看变更详情