project_id

是

String

项目ID。 获取方法请参见"获取项目ID"。

availability_zone

否

String

可用区信息。

dedicated_storage_id

否

String

专属存储池ID，可过滤出该专属存储池下的所有云硬盘，必须精确匹配。

dedicated_storage_name

否

String

专属存储池的名字，可过滤出该专属存储池下的所有云硬盘，支持模糊匹配。

enterprise_project_id

否

String

指定企业项目id进行过滤。 传入“all_granted_eps”，代表查询权限范围内的所有企业项目下的云硬盘。

id

否

String

云硬盘ID。

ids

否

String

云硬盘id列表，格式为ids=['id1','id2',...,'idx']，返回“ids”中有效id的云硬盘详情，无效的id会被忽略。 支持查询最多60个id对应的云硬盘详情。 如果“id”和“ids”查询参数同时存在，“id”会被忽略。

limit

否

Integer

返回结果个数限制。默认值为1000。

最小值：1

最大值：1000

缺省值：1000

marker

否

String

通过云硬盘ID进行分页查询。默认为查询第一页数据。

metadata

否

String

云硬盘元数据。

multiattach

否

Boolean

是否为共享云硬盘。 true：表示为共享云硬盘。 false：表示为非共享云硬盘。

name

否

String

磁盘名称。

offset

否

Integer

偏移量（偏移量为一个大于0小于磁盘总个数的整数，表示查询该偏移量后面的所有的磁盘）。

server_id

否

String

云服务器id。

service_type

否

String

服务类型，仅支持EVS、DSS、DESS。

sort_dir

否

String

返回结果按照降序或升序排列，默认为“desc”。 降序：desc 升序：asc

sort_key

否

String

返回结果按该关键字排序，支持id，status，size，created_at等关键字，默认为“created_at”。

status

否

String

云硬盘状态，取值可参考："云硬盘状态"。

volume_type_id

否

String

云硬盘类型id。 通过"查询云硬盘类型列表"可以查到，即volume_types参数说明表格中的“id”

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

count

Integer

查询到的云硬盘总数量，不受分页影响。

volumes_links

Array of Link objects

云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前磁盘mark标记的url，可以继续使用这个url查询剩余列表信息。

volumes

Array of VolumeDetail objects

查询请求返回的云硬盘列表。

id

String

云硬盘的ID。

links

Array of Link objects

云硬盘URI自描述信息。

name

String

云硬盘名称。

status

String

云硬盘状态，请参见云硬盘状态。

attachments

Array of Attachment objects

云硬盘的挂载信息。

availability_zone

String

云硬盘所属的AZ信息。

os-vol-host-attr:host

String

预留属性。

source_volid

String

源云硬盘ID，如果是从源云硬盘创建，则有值。

当前云硬盘服务不支持该字段。

snapshot_id

String

快照ID，如果是从快照创建，则有值。

description

String

云硬盘描述。

created_at

String

云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

os-vol-tenant-attr:tenant_id

String

云硬盘所属的租户ID。租户ID就是项目ID。

volume_image_metadata

Map<String,Object>

云硬盘镜像的元数据。

volume_type

String

云硬盘类型。 目前支持"SATA"，"SAS"，"GPSSD"和"SSD"四种。

• "SATA"为普通IO云硬盘

• "SAS"为高IO云硬盘

• "GPSSD"为通用型SSD云硬盘

• "SSD"为超高IO云硬盘

size

Integer

云硬盘大小，单位为GB。

consistencygroup_id

String

预留属性。

bootable

String

是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。

metadata

VolumeMetadata object

云硬盘的元数据。

updated_at

String

云硬盘更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

encrypted

Boolean

当前云硬盘服务不支持该字段。

replication_status

String

预留属性。

os-volume-replication:extended_status

String

预留属性。

os-vol-mig-status-attr:migstat

String

预留属性。

os-vol-mig-status-attr:name_id

String

预留属性。

shareable

String

是否为共享云硬盘。true为共享盘，false为普通云硬盘。 该字段已经废弃，请使用multiattach。

user_id

String

预留属性。

service_type

String

服务类型，结果为EVS、DSS、DESS。

multiattach

Boolean

是否为共享云硬盘。

dedicated_storage_id

String

云硬盘所属的专属存储池ID。

dedicated_storage_name

String

云硬盘所属的专属存储池的名称。

tags

Map<String,String>

云硬盘的标签。 如果云硬盘有标签，则会有该字段，否则该字段为空。

wwn

String

云硬盘挂载时的唯一标识。

enterprise_project_id

String

云硬盘上绑定的企业项目ID。

serial_number

String

云硬盘序列号。 只有SCSI类型的非双活卷才会返回该字段，用于与虚拟机中的盘做对应关系。

href

String

对应的快捷链接。

rel

String

快捷链接标记名称。

attached_at

String

挂载的时间信息。

时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

attachment_id

String

挂载信息对应的ID。

device

String

挂载点。

host_name

String

云硬盘挂载到的云服务器对应的物理主机的名称。

id

String

挂载的资源ID。

server_id

String

云硬盘挂载到的云服务器的 ID。

volume_id

String

云硬盘ID。

__system__cmkid

String

metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。

__system__encrypted

String

metadata中的表示加密功能的字段，0代表不加密，1代表加密。 不指定该字段时，云硬盘的加密属性与数据源保持一致，如果不是从数据源创建的场景，则默认不加密。

full_clone

String

从快照创建云硬盘时的创建方式。

• 0表示使用链接克隆方式。

• 1表示使用全量克隆方式。

hw:passthrough

String

• true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。

• false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。

• 该字段不存在时，云硬盘默认为VBD类型。

orderID

String

metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。

error

Error object

出现错误时，返回的错误信息

code

String

出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。

message

String

错误提示信息。

200

OK

400

Bad Request