文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 磁盘管理/ 查询可用磁盘类型
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询可用磁盘类型

功能介绍

该接口用于查询可用磁盘类型。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/volume-type

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

volume_types

Array of VolumeTypeInfo objects

磁盘列表。
表4 VolumeTypeInfo

参数

参数类型

描述

resource_spec_code

String

资源规格编码。

volume_type

String

磁盘类型。

volume_product_type

String

磁盘产品类型。

resource_type

String

资源类型字段。

cloud_service_type

String

资源所属云服务类型编码。

name

Array<Map<String，String>>

磁盘中英文名称。

volume_type_extra_specs

VolumeTypeExtraSpecs object

磁盘扩展属性，例如：已售罄的可用区。
表5 VolumeTypeExtraSpecs

参数

参数类型

描述

availability_zone

String

该类型磁盘对应的可用分区。

sold_out_availability_zone

String

已售罄的磁盘可用区。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/volume-type

响应示例

状态码： 200

成功响应。

{
  "volume_types" : [ {
    "resource_spec_code" : "workspace.volume.high",
    "volume_type" : "SAS",
    "volume_product_type" : "workspace",
    "resource_type" : "hws.resource.type.workspace.volume",
    "cloud_service_type" : "hws.service.type.vdi",
    "name" : [ {
      "language" : "en-us",
      "value" : "High IO Disk"
    }, {
      "language" : "zh-cn",
      "value" : "高IO磁盘"
    } ],
    "volume_type_extra_specs" : {
      "availability_zone" : "cn-north-5b,cn-north-5c,cn-north-5a",
      "sold_out_availability_zone" : ""
    }
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 磁盘管理

相关文档