Help Center/ Workspace/ API Reference/ Workspace APIs/ Disk/ Querying Disk Product Information

Updated on 2025-07-14 GMT+08:00

View PDF

Querying Disk Product Information

Function

Queries disk product information.

Debugging

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

URI

GET /v2/{project_id}/volume/products

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
availability_zone	No	String	AZ.
volume_type	No	String	Disk type. Multiple disk types are separated by commas (,): SATA: common I/O disk SAS: high I/O disk SSD: ultra-high I/O disk

Request Parameters

**Table 3** 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.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
volumes	Array of VolumeProductInfo objects	Disk product information list.

**Table 5** VolumeProductInfo
Parameter	Type	Description
resource_spec_code	String	Product ID.
volume_type	String	Disk type: SATA: common I/O disk SAS: high I/O disk SSD: ultra-high I/O disk
volume_product_type	String	Product type. The value is workspace.
resource_type	String	Resource type.
cloud_service_type	String	Cloud service type.
domain_ids	Array of strings	ID of the dedicated domain supported by the disk.
name	Array of I18nLanguage objects	Disk name.
status	String	Product status. The value can be normal or sellout.

**Table 6** I18nLanguage
Parameter	Type	Description
language	String	Language.
value	String	Value.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

/v2/0e3f393ae380f5d12facc005678bcd4b/volume/products?vailability_zone=cn-north-4a&volume_type=SSD,SAS

Example Responses

Status code: 200

Response to the request for querying EVS disk types.

{
  "volumes" : [ {
    "resource_spec_code" : "workspace.volume.ultrahigh",
    "volume_type" : "SSD",
    "volume_product_type" : "workspace",
    "resource_type" : "hws.resource.type.workspace.volume",
    "cloud_service_type" : "hws.service.type.vdi",
    "name" : [ {
      "language" : "en-us",
      "value" : "Ultra high IO Disk"
    }, {
      "language" : "zh-cn",
      "value" : "Ultra-high I/O disk"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying EVS disk types.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources 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.