文档首页/ 云硬盘 EVS/ API参考/ API/ 云硬盘管理/ 查询所有云硬盘详情(废弃)

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

在线调试

CLI示例

查看PDF

查询所有云硬盘详情(废弃)

功能介绍

分类查询所有云硬盘详情。

注意：

该接口已废弃，请使用性能更佳的接口

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/os-vendor-volumes/detail

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

表2 Query参数
参数	是否必选	参数类型	描述
availability_zone	否	String	AZ信息
dedicated_storage_id	否	String	专属存储池ID，可过滤出该专属存储池下的所有云硬盘，必须精确匹配
dedicated_storage_name	否	String	专属存储池的名字，可过滤出该专属存储池下的所有云硬盘，支持模糊匹配
id	否	String	云硬盘id。
ids	否	Array of strings	云硬盘id列表，格式为ids=['id1','id2',...,'idx']，返回“ids”中有效id的云硬盘详情，无效的id会被忽略。支持查询最多60个id对应的云硬盘详情。如果“id”和“ids”查询参数同时存在，“id”会被忽略
limit	否	Integer	返回结果个数限制，取值为大于0的整数。默认值为1000。
marker	否	String	取值为上一页数据的最后一条记录的id，返回值为该项后面的项
metadata	否	String	云硬盘元数据
multiattach	否	Boolean	是否为可共享云硬盘
name	否	String	云硬盘名称
offset	否	Integer	偏移量（偏移量为一个大于0小于云硬盘总个数的整数，表示查询该偏移量后面的所有的云硬盘）
service_type	否	String	服务类型，仅支持EVS、DSS、DESS。
sort_dir	否	String	降序或升序(默认为“desc”)。
sort_key	否	String	返回结果按该关键字排序（支持id，status，size，created_at等关键字，默认为“created_at”）
status	否	String	云硬盘状态
volume_type_id	否	String	云硬盘类型id
snapshot_policy_id	否	String	自动快照策略ID

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	查询到的云硬盘总数量，不受分页影响。
volumes	Array of DiskDetail objects	查询请求返回的云硬盘列表。
volumes_links	Array of Link objects	云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前云硬盘mark标记的url，可以继续使用这个url查询剩余列表信息。

表5 DiskDetail
参数	参数类型	描述
attachments	Array of DiskAttachment objects	云硬盘的挂载信息。
availability_zone	String	云硬盘所属的AZ信息。
bootable	String	是否为可启动云硬盘。
consistencygroup_id	String	所属一致性组ID。
count	String	已查询出的云硬盘列表中云硬盘的数量
created_at	String	云硬盘创建时间。时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
dedicated_storage_id	String	云硬盘所属的专属存储池ID
dedicated_storage_name	String	云硬盘所属的专属存储池的名称
description	String	云硬盘描述。
encrypted	Boolean	是否为加密云硬盘。
enterprise_project_id	String	云硬盘上绑定的企业项目ID。当前云硬盘服务不支持该字段
id	String	云硬盘ID。
links	Array of Link objects	云硬盘URI自描述信息。
metadata	DiskMetadata object	元数据。
multiattach	Boolean	创建共享云硬盘的信息
name	String	云硬盘名称。
os-vendor-extended:lock_check_endpoint	String	检查锁是否有效的回调链接
os-vendor-extended:lock_scene	String	云硬盘的加锁类型。取值范围： TO_PERIOD_LOCK：按需转包 SPEC_CHG_LOCK：规格变更 OTHER_SVC_LOCK：其他场景
os-vendor-extended:lock_source_id	String	云硬盘的锁归属的资源ID
os-vendor-extended:lock_source_service	String	云硬盘的锁归属的服务类型
os-vol-host-attr:host	String	云硬盘所在的主机
os-vol-mig-status-attr:migstat	String	预留属性
os-vol-mig-status-attr:name_id	String	预留属性
os-vol-tenant-attr:tenant_id	String	云硬盘所属的租户ID
os-volume-replication:driver_data	String	预留属性
os-volume-replication:extended_status	String	预留属性
replication_status	String	预留属性
service_type	String	服务类型，结果为EVS、DSS、 DESS。
shareable	String	是否为可共享云硬盘。
size	Integer	云硬盘大小。
snapshot_id	String	快照ID。
source_volid	String	源云硬盘ID。
status	String	云硬盘状态，请参见云硬盘状态。
tags	Object	云硬盘的标签。如果云硬盘有标签，则会有该字段，否则该字段为空。
updated_at	String	云硬盘更新时间。
user_id	String	预留属性
volume_image_metadata	Object	如果云硬盘是从镜像创建的则会有该字段，否则该字段为空。说明：关于“volume_image_metadata”字段的详细说明，具体请参见查询镜像详情。
volume_type	String	云硬盘类型。目前支持"SATA"，"SAS"，"GPSSD"和"SSD"四种。 "SATA"为普通IO云硬盘 "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘
wwn	String	云硬盘挂载时的唯一标识

表6 DiskAttachment
参数	参数类型	描述
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 DiskMetadata
参数	参数类型	描述
__system__cmkid	String	metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。
__system__encrypted	String	metadata中的表示加密功能的字段，0代表不加密，1代表加密。该字段不存在时，云硬盘默认为不加密。
hw:passthrough	String	metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。该字段不存在时，云硬盘默认为VBD类型。

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

状态码：400

表9 响应Body参数
参数	参数类型	描述
error	Error object	参数解释出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。取值范围不涉及。

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

请求示例

GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/detail

https://{endpoint}/v2/{project_id}/os-vendor-volumes/detail

响应示例

状态码：200

{
  "count" : 1,
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "xxx",
    "bootable" : "false",
    "created_at" : "2016-05-25T02:42:10.856332",
    "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" : {
      "__openstack_region_name" : "pod01.xxx",
      "a" : "b",
      "quantityGB" : "1",
      "volInfoUrl" : "fusionstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D"
    },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA",
    "service_type" : "EVS",
    "wwn" : " 688860300000d136fa16f48f05992360"
  } ],
  "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

错误码

请参见错误码。

父主题：云硬盘管理

上一篇：扩容云硬盘(废弃)

下一篇：查询单个云硬盘详情(废弃)

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消