
# 查询可用磁盘类型 - ListVolumeType
#### 功能介绍
该接口用于查询可用磁盘类型。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListVolumeType)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                         | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:baseResource:list | List | -           | -   | -  | -      |
     
  
 
#### 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 | 磁盘列表。 |
   
 表4VolumeTypeInfo 
| 参数                      | 参数类型                                                                          | 描述                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| resource_spec_code      | String                                                                        | 资源规格编码。                                                                                                                                                                                                                                                                                                                                                                                     |
| volume_type             | String                                                                        | 磁盘类型： - SSD：超高IO磁盘   - SAS：高IO磁盘                                        |
| volume_product_type     | String                                                                        | 磁盘产品类型： - workspace                                                                                                                                                                             |
| resource_type           | String                                                                        | 资源类型: -hws.resource.type.workspace.volume： 云办公桌面磁盘 -hws.resource.type.workspace.desktop： 云办公桌面 -hws.resource.type.workspace.appstream： 云应用 -hws.resource.type.workspace.appstreamsession： 云应用多会话                                                    |
| cloud_service_type      | String                                                                        | 资源所属云服务类型编码： - hws.service.type.vdi   - hws.service.type.marketplace    |
| name                    | Array of Map\<String,Object\> objects                                         | 磁盘中英文名称。                                                                                                                                                                                                                                                                                                                                                                                    |
| volume_type_extra_specs | [VolumeTypeExtraSpecs] object | 磁盘扩展属性，例如：已售罄的可用区。                                                                                                                                                                                                                                                                                                                                                                          |
   
 表5VolumeTypeExtraSpecs 
| 参数                         | 参数类型   | 描述            |
|:---|:---|:---|
| 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 | 错误描述。      |
   
**状态码：404**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：405**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：500**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：503**
表12响应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 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。
