文档首页/云桌面 Workspace/API参考/云桌面API/磁盘/查询磁盘产品信息 - ListVolumeProductInfo
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

查询磁盘产品信息 - ListVolumeProductInfo

功能介绍

查询磁盘产品信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/volume/products

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone

否

String

可用分区。

volume_type

否

String

磁盘类型（多个磁盘类型用逗号隔开）：

  • SATA: 普通IO磁盘

  • SAS：高IO磁盘

  • SSD：超高IO磁盘

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

volumes

Array of VolumeProductInfo objects

磁盘产品信息列表。

表4 VolumeProductInfo

参数

参数类型

描述

resource_spec_code

String

产品ID。

volume_type

String

磁盘类型：

  • SATA: 普通IO磁盘

  • SAS：高IO磁盘

  • SSD：超高IO磁盘

volume_product_type

String

产品类型：workspace。

resource_type

String

资源类型。

cloud_service_type

String

云服务类型。

domain_ids

Array of strings

该磁盘支持的专有域id（domainId）。

name

Array of I18nLanguage objects

磁盘名称。

status

String

产品状态，normal：正常、sellout：售空。

iops

Iops object

云硬盘每秒进行读写的操作次数。

throughput

Throughput object

云硬盘每秒成功传送的数据量，即读取和写入的数据量。

表5 I18nLanguage

参数

参数类型

描述

language

String

语言。

value

String

值。

表6 Iops

参数

参数类型

描述

resource_spec_code

String

产品ID。

min

Integer

最小值。

max

Integer

最大值。

range_by_size

Number

可取值范围，<=rangeBySize乘size。

表7 Throughput

参数

参数类型

描述

resource_spec_code

String

产品ID。

min

Integer

最小值。

max

Integer

最大值。

range_by_iops

Number

可取值范围，<=rangeByIops乘iops。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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

响应示例

状态码：200

查询云硬盘类型列表响应。

{
  "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" : "超高IO磁盘"
    } ],
    "iops" : {
      "resource_spec_code" : "workspace.volume.iops",
      "min" : 3000,
      "max" : 128000,
      "range_by_size" : 500
    },
    "throughput" : {
      "resource_spec_code" : "workspace.volume.throughput",
      "min" : 125,
      "max" : 1000,
      "range_by_iops" : 0.25
    }
  } ]
}

状态码

状态码

描述

200

查询云硬盘类型列表响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

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

503

服务不可用。

错误码

请参见错误码。

父主题：磁盘