云主机 > API 文档 > 实例 >查看可用资源列表

查看可用资源列表

最近更新时间: 2022-10-09 15:11:03

请求路径

POST /v1/vm/resource_available

请求参数

名称	类型	位置	必填	描述
x-qiniu-regionid	string	header	是	地域 ID。您可以调用 DescribeRegions 查看最新的七牛云地域列表。
destination_resource	string	body	是	要查询的资源类型。取值范围： Zone：可用区 IoOptimized：I/O 优化 InstanceType：实例规格 SystemDisk：系统盘 DataDisk：数据盘 Network：网络类型 ddh：专有宿主机参数 DestinationResource 的取值方式请参见上文接口说明。
zone_id	string	body	否	可用区 ID。默认值：无，表示随机分配当前地域下的可用区，返回该地域（RegionId）下所有可用区的符合查询条件的资源。
instance_charge_type	string	body	否	资源的计费方式。更多详情，请参见计费概述。取值范围： PrePaid：包年包月 PostPaid：按量付费默认值：PostPaid
instance_type	string	body	否	实例规格。更多详情，请参见实例规格族，也可以调用 DescribeInstanceTypes 接口获得最新的规格表。当参数 DestinationResource 取值为 SystemDisk 或者 DataDisk 时，InstanceType 为必需参数。
system_disk_category	string	body	否	系统盘类型。取值范围：若参数 DestinationResource 取值为 SystemDisk、InstanceType 或者 DataDisk 时，参数 SystemDiskCategory 不是必需参数。默认值：cloud_efficiency
data_disk_category	string	body	否	数据盘类型。取值范围：
network_category	string	body	否	网络类型。取值范围： vpc：专有网络 classic：经典网络

返回值

名称	类型	描述
request_id	string	请求 ID
data	object{ “available_zone”： AvailableZoneType[] }	数据中信息组成的集合

AvailableZoneType

名称	类型	描述
region_id	string	地域 ID
zone_id	string	可用区 ID
status	string	资源状态。返回值： Available：资源充足 SoldOut：资源已售罄
available_resources	object{“available_resources”: AvailableResource[]}	支持的可供创建的具体资源组成的数组

AvailableResource

名称	类型	描述
type	string	资源值
supported_resources	object{“supported_resource”: SupportedResource[]}	支持的可供创建的具体资源组成的数组。

SupportedResource

名称	类型	描述
value	string	资源值。
status	string	资源状态。可能值： Available：资源充足 SoldOut：资源已售罄
min	integer	资源规格的最小值，该参数值为空时将不返回。
max	integer	资源规格的最大值，该参数值为空时将不返回。
unit	string	资源规格单位，该参数值为空时将不返回。

返回值示例

{
  "data": {
    "available_zone": [
      {
        "region_id": "cn-qingdao",
        "zone_id": "cn-qingdao-c",
        "status": "Available",
        "available_resources": {
          "available_resources": [
            {
              "type": "InstanceType",
              "supported_resources": {
                "supported_resource": [
                  {
                    "value": "ecs.e4.2xlarge",
                    "status": "Available"
                  },
                  {
                    "value": "ecs.c6.4xlarge",
                    "status": "SoldOut"
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "region_id": "cn-qingdao",
        "zone_id": "cn-qingdao-b",
        "status": "Available",
        "available_resources": {
          "available_resources": [
            {
              "type": "InstanceType",
              "supported_resources": {
                "supported_resource": [
                  {
                    "value": "ecs.e4.2xlarge",
                    "status": "Available"
                  },
                  {
                    "value": "ecs.sn2ne.2xlarge",
                    "status": "Available"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  },
  "request_id": "N8cGF9hhROnf1FAW"
}

以上内容是否对您有帮助？