# 查询所有云硬盘详情(废弃) - ListVolumesV3 #### 功能介绍 查询所有云硬盘的详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{project_id}/os-vendor-volumes/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | 返回结果个数限制。 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 | | marker | 否 | String | 分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。 | | metadata | 否 | String | 云硬盘元数据。 | | multiattach | 否 | String | 是否为共享云硬盘。 true：表示为共享云硬盘。 false：表示为非共享云硬盘。 | | name | 否 | String | 云硬盘名称。最大支持64个字符。 | | offset | 否 | Integer | 偏移量（偏移量为一个大于0小于云硬盘总个数的整数，表示查询该偏移量后面的所有的云硬盘）。 | | service_type | 否 | String | 服务类型，仅支持EVS、DSS、DESS。 | | sort_dir | 否 | String | 降序或升序，默认为"desc"。 desc表示降序。 asc表示升序。 | | sort_key | 否 | String | **参数解释** 返回结果按该关键字排序。 **约束限制** 不涉及。 **取值范围** - id：云硬盘ID。 - status：云硬盘状态，取值可参考：\["[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)"\]。 - size：云硬盘大小，单位为GiB。 - created_at：云硬盘创建时间。 **默认取值** created_at | | status | 否 | String | 云硬盘状态，具体请参见[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)。 | | volume_type_id | 否 | String | 云硬盘类型ID。通过 [查询云硬盘类型列表](https://support.huaweicloud.com/api-evs/evs_04_3035.html#:~:text=描述-,id,-String) 可以查到，即VolumeType参数说明表格中的"id"。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 查询到的云硬盘总数量 | | volumes | Array of [VolumeDetailV3] objects | 查询请求返回的云硬盘列表 | | volumes_links | Array of [LinkV3] objects | 云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前云硬盘mark标记的url，可以继续使用这个url查询剩余列表信息，请参见• [links参数说明](https://support.huaweicloud.com/api-evs/evs_04_2006.html)。 | 表5VolumeDetailV3 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attachments | Array of [AttachmentV3] objects | 挂载信息，请参见 •[attachments参数说明](https://support.huaweicloud.com/api-evs/evs_04_2006.html)。 | | availability_zone | String | 云硬盘所属AZ。 | | bootable | String | 是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。 | | consistencygroup_id | 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的获取及企业项目特性的详细信息，请参见 [企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html) | | id | String | 云硬盘ID。 | | links | Array of [LinkV3] objects | 云硬盘URI自描述信息，请参见 •[links参数说明](https://support.huaweicloud.com/api-evs/evs_04_2006.html)。 | | metadata | [VolumeMetadataV3] object | 元数据信息 | | multiattach | Boolean | 是否为共享云硬盘。 - true：表示为共享云硬盘。 - false：表示为非共享云硬盘。 | | name | String | 云硬盘名称。 | | replication_status | String | 预留属性。 | | service_type | String | 服务类型，结果为EVS、DSS、DESS。 | | shareable | Boolean | 是否为共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。 | | size | Integer | 云硬盘大小，单位为GiB。 | | snapshot_id | String | 快照ID，如果是从快照创建，则有值。 | | source_volid | String | 源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。 | | status | String | 云硬盘状态，具体请参见[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)。 | | tags | Map\ | 云硬盘的标签。 如果云硬盘有标签，则会有该字段，否则该字段为空。 | | updated_at | String | 云硬盘更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | user_id | String | 预留属性。 | | volume_image_metadata | Object | 云硬盘镜像的元数据。 说明： 关于"volume_image_metadata"字段的详细说明，具体请参见[查询镜像详情](https://support.huaweicloud.com/api-ims/ims_03_0703.html)。 | | volume_type | String | 云硬盘类型。 目前支持"SATA"，"SAS"，"GPSSD"和"SSD"四种。 - "SATA"为普通IO云硬盘 - "SAS"为高IO云硬盘 - "GPSSD"为通用型SSD云硬盘 - "SSD"为超高IO云硬盘 | | wwn | String | 云硬盘挂载时的唯一标识。 | | os-vol-tenant-attr:tenant_id | String | 云硬盘所属的租户ID。租户ID就是项目ID。 | | os-vol-mig-status-attr:migstat | String | 预留属性。 | | os-vol-mig-status-attr:name_id | String | 预留属性。 | | os-volume-replication:extended_status | String | 预留属性。 | | os-vol-host-attr:host | String | 预留属性。 | | storage_cluster_id | String | 预留属性。 | 表6AttachmentV3 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表7VolumeMetadataV3 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | __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类型。 | | orderID | String | metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。 | 表8LinkV3 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | 对应的快捷链接。 | | rel | String | 快捷链接标记名称。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 不涉及。 | 表10Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/{project_id}/os-vendor-volumes/detail ``` #### 响应示例 **状态码：200** OK ``` { "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/v3/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", "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/v3/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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。