文档首页/ 云硬盘 EVS/ API参考/ 历史API/ Cinder API/ 云硬盘管理/ 查询所有云硬盘详情 - CinderListVolumesDetailsV3

更新时间：2025-11-11 GMT+08:00

在线调试

CLI示例

查看PDF

查询所有云硬盘详情 - CinderListVolumesDetailsV3

功能介绍

查询所有云硬盘详情。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v3/{project_id}/volumes/detail

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
marker	否	String	取值为上一页数据的最后一条记录的id，返回值为该项后面的项
name	否	String	云硬盘名称。最大支持64个字符。
limit	否	Integer	返回结果个数限制。最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。当租户所有的云硬盘数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v2/xxx/volumes/detail?limit=50，表示查询第1~50个云硬盘。GET /v2/xxx/volumes/detail?offset=50&limit=50，表示查询第51~100个云硬盘。
sort_key	否	String	返回结果按该关键字排序，支持id，status，size，created_at等关键字，默认为“created_at”。
sort_dir	否	String	返回结果按照降序或升序排列，默认为“desc”。降序：desc 升序：asc
offset	否	Integer	偏移量偏移量为一个大于0小于磁盘总个数的整数，表示查询该偏移量后面的所有的云硬盘。
status	否	String	云硬盘状态，具体请参见云硬盘状态。
metadata	否	String	云硬盘元数据。该参数通过Json格式进行传参，如：GET /v3/{project_id}/volumes/detail?metadata={"hw:passthrough": "true"}
availability_zone	否	String	AZ信息

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
volumes	Array of VolumeDetail objects	参数解释查询请求返回的云硬盘列表。取值范围不涉及。
volumes_links	Array of Link objects	参数解释云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前云硬盘mark标记的url，可以继续使用这个url查询剩余列表信息。取值范围不涉及。

表5 VolumeDetail
参数	参数类型	描述
id	String	参数解释云硬盘ID。取值范围不涉及。
links	Array of Link objects	参数解释云硬盘uri自描述信息。取值范围不涉及。
name	String	参数解释云硬盘名称。取值范围不涉及。
status	String	参数解释云硬盘状态，具体请参见云硬盘状态。取值范围不涉及。
attachments	Array of VolumeAttachment objects	参数解释是否挂载信息。取值范围不涉及。
availability_zone	String	参数解释云硬盘所属可用区。取值范围不涉及。
disaster_recovery_azs	Array of strings	参数解释容灾云硬盘所属的多个可用区。取值范围不涉及。
source_volid	String	参数解释源云硬盘ID，如果是从源云硬盘创建，则有值。当前云硬盘服务不支持该字段。取值范围不涉及。
snapshot_id	String	参数解释快照ID，如果是从快照创建，则有值。取值范围不涉及。
description	String	参数解释云硬盘描述。取值范围不涉及。
bootable	String	参数解释是否为启动云硬盘。取值范围 true：表示为启动云硬盘。 false：表示为非启动云硬盘。
encrypted	Boolean	参数解释当前云硬盘服务不支持该字段。取值范围不涉及。
created_at	String	参数解释云硬盘创建时间。取值范围时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
volume_type	String	参数解释云硬盘类型。取值范围目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"，"ESSD2"七种。 "SATA"为普通IO云硬盘(已售罄) "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 "ESSD"为极速型SSD云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘
replication_status	String	参数解释预留属性。取值范围不涉及。
consistencygroup_id	String	参数解释预留属性。取值范围不涉及。
metadata	VolumeMetadata object	参数解释云硬盘的元数据。如果元数据中不包含hw:passthrough字段，云硬盘默认为VBD类型。如果元数据中不包含__system__encrypted字段，云硬盘默认为不加密。取值范围不涉及。
size	Integer	参数解释云硬盘大小，单位为GiB。取值范围不涉及。
user_id	String	参数解释预留属性。取值范围不涉及。
updated_at	String	参数解释云硬盘更新时间。取值范围时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
shareable	Boolean	参数解释是否为可共享云硬盘。说明：该字段已经废弃，请使用multiattach。取值范围不涉及。
multiattach	Boolean	参数解释是否为可共享云硬盘。取值范围 true：表示可共享云硬盘。 false：表示普通云硬盘。
os-vol-tenant-attr:tenant_id	String	参数解释云硬盘所属的项目ID。取值范围不涉及。
volume_image_metadata	Object	参数解释云硬盘镜像的元数据。取值范围关于“volume_image_metadata”字段的详细说明，具体请参见："查询镜像详情"。
os-vol-host-attr:host	String	参数解释预留属性。取值范围不涉及。
os-volume-replication:extended_status	String	参数解释预留属性。取值范围不涉及。
os-vol-mig-status-attr:migstat	String	参数解释预留属性。取值范围不涉及。
os-vol-mig-status-attr:name_id	String	参数解释预留属性。取值范围不涉及。
iops	iops object	参数解释云硬盘的iops信息，云硬盘类型是ESSD2、GPSSD2才返回。取值范围不涉及。
throughput	throughput object	参数解释云硬盘的吞吐量信息，云硬盘类型是GPSSD2才返回。取值范围不涉及。
snapshot_policy_id	String	参数解释云硬盘绑定的快照策略ID。取值范围不涉及。

表6 VolumeAttachment
参数	参数类型	描述
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。取值范围不涉及。

表7 VolumeMetadata
参数	参数类型	描述
__system__cmkid	String	参数解释 metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。取值范围请参考查询密钥列表，通过HTTPS请求获取密钥ID。
__system__encrypted	String	参数解释 metadata中的表示加密功能的字段。该字段不存在时，云硬盘默认为不加密。取值范围 0：表示不加密。 1：表示加密。
hw:passthrough	String	参数解释 metadata中的表示云硬盘设备类型的字段。该字段不存在时，云硬盘默认为VBD类型。取值范围 true：表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false：表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。

表8 iops
参数	参数类型	描述
frozened	Boolean	参数解释冻结标签。取值范围不涉及。
id	String	参数解释云硬盘iops标识。取值范围不涉及。
total_val	Integer	参数解释 iops大小。取值范围不涉及。
volume_id	String	参数解释云硬盘ID。取值范围不涉及。

表9 throughput
参数	参数类型	描述
frozened	Boolean	参数解释冻结标签。取值范围不涉及。
id	String	参数解释云硬盘吞吐量标识。取值范围不涉及。
total_val	Integer	参数解释吞吐量大小。取值范围不涉及。
volume_id	String	参数解释云硬盘ID。取值范围不涉及。

**表10** Link
参数	参数类型	描述
href	String	参数解释对应的快捷链接。取值范围不涉及。
rel	String	参数解释快捷链接标记名称。取值范围不涉及。

状态码：400

**表11** 响应Body参数
参数	参数类型	描述
error	Error object	参数解释出现错误时，返回的错误信息。取值范围不涉及。

**表12** Error
参数	参数类型	描述
code	String	参数解释出现错误时，返回的错误码。取值范围错误码和其对应的含义请参考错误码说明。
message	String	参数解释出现错误时，返回的错误消息。取值范围不涉及。

请求示例

GET https://{endpoint}/v3/{project_id}/volumes/detail?status=available

响应示例

状态码：200

{
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "bootable" : "false",
    "consistencygroup_id" : null,
    "created_at" : "2016-05-25T02:42:10.856332",
    "description" : null,
    "encrypted" : false,
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "self"
    }, {
      "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "bookmark"
    } ],
    "metadata" : { },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-mig-status-attr:migstat" : null,
    "os-vol-mig-status-attr:name_id" : null,
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "os-volume-replication:extended_status" : null,
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "snapshot_id" : null,
    "source_volid" : null,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA"
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
    "rel" : "next"
  } ]
}

状态码：400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码	描述
200	OK
400	Bad Request

错误码

请参见错误码。

父主题：云硬盘管理

上一篇：创建云硬盘 - CinderCreateVolumeV3

下一篇：删除云硬盘 - CinderDeleteVolumeV3

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问