查询硬盘列表 - ListVolume
功能介绍
查询硬盘列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/cloudvolumes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 查询硬盘列表当前页面的数量。 取值范围：0~1000 |
| name | 否 | String | 根据名称查询硬盘列表。 |
| offset | 否 | Integer | 查询的偏移量。默认为0，取值：大于0。 |
| status | 否 | String | 根据状态查询硬盘列表，取值可参考："磁盘状态"。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 硬盘数量。 |
| volumes | Array of Volume objects | 硬盘列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 硬盘ID。 |
| status | String | 磁盘状态。云硬盘状态，请参见磁盘状态。 |
| size | Integer | 磁盘大小。 |
| availability_zone | String | 硬盘所属的AZ信息。 |
| attachments | Array of Attachment objects | 硬盘的挂载信息。 |
| name | String | 磁盘名称。 |
| description | String | 描述。 |
| volume_type | String | 云硬盘类型。 取值范围： 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"。 "SATA"为普通IO云硬盘 "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 |
| bootable | String | 是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。 |
| encrypted | Boolean | 显示该卷是否已被加密。 |
| multiattach | Boolean | 磁盘是否多挂载。 |
| metadata | Map<String,String> | 硬盘的元数据。 |
| site_id | String | 磁盘所在站点的ID。 |
| created_at | String | 磁盘创建时间。 |
| updated_at | String | 磁盘更新时间。 |
请求示例
GET https://{endpoint}/v1/cloudvolumes 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。
