Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Disk Management/ Querying Available Disk Types
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Available Disk Types

Function

Queries available disk types.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:baseResource:list

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/volume-type

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

volume_types

Array of VolumeTypeInfo objects

Disk list.
Table 4 VolumeTypeInfo

Parameter

Type

Description

resource_spec_code

String

Resource specification code.

volume_type

String

Disk type:

  • SSD: ultra-high I/O disk

  • SAS: high I/O disk

volume_product_type

String

Disk type.

  • workspace

resource_type

String

Resource type.

-hws.resource.type.workspace.volume: Workspace desktop disk

-hws.resource.type.workspace.desktop: Workspace desktop

-hws.resource.type.workspace.appstream: Workspace Application Streaming

-hws.resource.type.workspace.appstreamsession: Workspace Application Streaming multi-session

cloud_service_type

String

Code of the cloud service type to which the resource belongs.

  • hws.service.type.vdi

  • hws.service.type.marketplace

name

Array of Map<String,Object> objects

Chinese and English names of the disk.

volume_type_extra_specs

VolumeTypeExtraSpecs object

Specifies the extended attribute of the disk, for example, the AZ where the disk has been sold out.
Table 5 VolumeTypeExtraSpecs

Parameter

Type

Description

availability_zone

String

AZ of the disk type.

sold_out_availability_zone

String

AZs of sold-out disks.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/volume-type

Example Responses

Status code: 200

Response to a successful request.

{
  "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" : "High I/O Disk"
    } ],
    "volume_type_extra_specs" : {
      "availability_zone" : "cn-north-5b,cn-north-5c,cn-north-5a",
      "sold_out_availability_zone" : ""
    }
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Disk Management