更新时间:2024-02-27 GMT+08:00

查询云硬盘类型列表

功能介绍

查询云硬盘类型列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

volume_types

Array of VolumeType objects

查询请求返回的云硬盘类型列表。

表4 VolumeType

参数

参数类型

描述

id

String

云硬盘类型的ID。

name

String

云硬盘类型名称。

extra_specs

VolumeTypeExtraSpecs object

云硬盘类型的规格。

description

String

云硬盘类型的描述信息。

qos_specs_id

String

预留属性。

is_public

Boolean

预留属性。

表5 VolumeTypeExtraSpecs

参数

参数类型

描述

RESKEY:availability_zones

String

支持当前云硬盘类型的可用区列表,列表的元素以逗号分隔。 若没有该参数,则表示当前云硬盘类型支持所有可用区。

availability-zone

String

预留属性。

os-vendor-extended:sold_out_availability_zones

String

当前云硬盘类型已售罄的可用区列表,列表的元素以逗号分隔。

volume_backend_name

String

预留属性。

HW:availability_zone

String

预留属性。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

出现错误时,返回的错误信息。

表7 Error

参数

参数类型

描述

code

String

出现错误时,返回的错误码。

错误码和其对应的含义请参考错误码说明

message

String

出现错误时,返回的错误消息。

请求示例

GET https://{endpoint}/v2/{project_id}/types

响应示例

状态码: 200

OK

{
  "volume_types" : [ {
    "extra_specs" : {
      "availability-zone" : "az-dc-1",
      "volume_backend_name" : "SAS",
      "RESKEY:availability_zones" : "az-dc-1,az-dc-2",
      "os-vendor-extended:sold_out_availability_zones" : "az-dc-2"
    },
    "description" : null,
    "name" : "SAS",
    "id" : "6c81c680-df58-4512-81e7-ecf66d160638",
    "is_public" : true
  }, {
    "extra_specs" : {
      "availability-zone" : "az-dc-1",
      "volume_backend_name" : "SATA",
      "RESKEY:availability_zones" : "az-dc-1,az-dc-2",
      "os-vendor-extended:sold_out_availability_zones" : "az-dc-2"
    },
    "description" : null,
    "name" : "SATA",
    "qos_specs_id" : "585f29d6-7147-42e7-bfb8-ca214f640f6f",
    "is_public" : true,
    "id" : "ea6e3c13-aac5-46e0-b280-745ed272e662"
  }, {
    "extra_specs" : {
      "availability-zone" : "az-dc-1",
      "volume_backend_name" : "SSD",
      "RESKEY:availability_zones" : "az-dc-1,az-dc-2",
      "os-vendor-extended:sold_out_availability_zones" : "az-dc-2"
    },
    "description" : null,
    "name" : "SSD",
    "qos_specs_id" : "39b0c29a-308b-4f86-b478-5d3d02a43837",
    "is_public" : true,
    "id" : "6f2dee9e-82f0-4be3-ad89-bae605a3d24f"
  } ]
}

状态码: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码