# 查询所有云硬盘详情 - ListVolumes #### 功能介绍 查询所有云硬盘的详细信息。 #### 调用方法 请参见[如何调用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)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | evs:volumes:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/cloudvolumes/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释** 通过云硬盘ID进行分页查询，默认为查询第一页数据。marker={{id}}表示查询该云硬盘id后的所有云硬盘的信息(查询结果不包含该id的云硬盘信息)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | name | 否 | String | **参数解释** 云硬盘名称。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | limit | 否 | Integer | **参数解释** 返回结果个数限制。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 1000 | | sort_key | 否 | String | **参数解释** 返回结果按该关键字排序。 **约束限制** 不涉及。 **取值范围** - id：云硬盘ID。 - status：云硬盘状态，取值可参考：\["[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)"\]。 - size：云硬盘大小，单位为GiB。 - created_at：云硬盘创建时间。 **默认取值** created_at | | offset | 否 | Integer | **参数解释** 偏移量。 **约束限制** 说明:查询云硬盘列表时使用，与limit配合使用。假如共有30个云硬盘，设置offset为11，limit为10，即为从第12个云硬盘开始查询，一次最多可读取10个云硬盘。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | sort_dir | 否 | String | **参数解释** 返回结果按照降序或升序排列。 **约束限制** 不涉及。 **取值范围** 降序：desc 升序：asc **默认取值** desc | | status | 否 | String | **参数解释** 云硬盘状态，取值可参考：\["[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)"\]。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | metadata | 否 | String | **参数解释** 云硬盘元数据。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | availability_zone | 否 | String | **参数解释** 可用区信息。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | multiattach | 否 | Boolean | **参数解释** 是否为共享云硬盘。 **约束限制** 不涉及。 **取值范围** true：表示为共享云硬盘。 false：表示为非共享云硬盘。 **默认取值** 不涉及。 | | service_type | 否 | String | **参数解释** 服务类型。 **约束限制** 不涉及。 **取值范围** - EVS：云硬盘。 - DSS：专属分布式存储服务。 - DESS：专属企业存储服务。 **默认取值** 不涉及。 | | dedicated_storage_id | 否 | String | **参数解释** 专属存储池ID，可过滤出该专属存储池下的所有云硬盘，必须精确匹配。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | dedicated_storage_name | 否 | String | **参数解释** 专属存储池的名字，可过滤出该专属存储池下的所有云硬盘，支持模糊匹配。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | volume_type_id | 否 | String | **参数解释** 云硬盘类型id。 通过"[查询云硬盘类型列表](https://support.huaweicloud.com/api-evs/evs_04_3035.html)"可以查到，即VolumeType参数说明表格中的"id" **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | id | 否 | String | **参数解释** 云硬盘ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | ids | 否 | String | **参数解释** 云硬盘id列表，格式为ids=\["id1","id2",...,"idx"\]，返回"ids"中有效id的云硬盘详情，无效的id会被忽略。 **约束限制** 支持查询最多60个id对应的云硬盘详情。 如果"id"和"ids"查询参数同时存在，"id"会被忽略。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释** 指定企业项目id进行过滤。 传入"all_granted_eps"，代表查询权限范围内的所有企业项目下的云硬盘。 关于企业项目ID的获取及企业项目特性的详细信息，请参考："[企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html)"。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | server_id | 否 | String | **参数解释** 云服务器id。 可通过弹性云服务器服务的[查询云服务器详情列表](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0094148850.html)接口获取云服务器ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | bootable | 否 | Boolean | **参数解释** 是否为启动盘/系统盘。 **约束限制** 不涉及。 **取值范围** true表示为启动盘/系统盘，false表示为数据盘 **默认取值** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释** 查询到的云硬盘总数量，不受分页影响。 **取值范围** 不涉及。 | | volumes_links | Array of [Link] objects | **参数解释** 云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前云硬盘mark标记的url，可以继续使用这个url查询剩余列表信息。 **取值范围** 不涉及。 | | volumes | Array of [VolumeDetail] objects | **参数解释** 查询请求返回的云硬盘列表。 **取值范围** 不涉及。 | 表5VolumeDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 云硬盘的ID。 **取值范围** 不涉及。 | | links | Array of [Link] objects | **参数解释** 云硬盘URI自描述信息。 **取值范围** 不涉及。 | | name | String | **参数解释** 云硬盘名称。 **取值范围** 不涉及。 | | status | String | **参数解释** 云硬盘状态。 **取值范围** 请参见[云硬盘状态](https://support.huaweicloud.com/api-evs/evs_04_0040.html)。 | | 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\ | **参数解释** 云硬盘镜像的元数据。 关于"volume_image_metadata"字段的详细说明，具体请参见[查询镜像详情](https://support.huaweicloud.com/api-ims/ims_03_0703.html)。 **取值范围** 不涉及。 | | volume_type | String | **参数解释** 云硬盘类型。 **取值范围** 通过[查询云硬盘类型列表](https://support.huaweicloud.com/api-evs/evs_04_3035.html)接口获取当前可用的云硬盘类型 - "SATA"为普通IO云硬盘(已售罄) - "SAS"为高IO云硬盘 - "GPSSD"为通用型SSD云硬盘 - "SSD"为超高IO云硬盘 - "ESSD"为极速型SSD云硬盘 - "GPSSD2"为通用型SSD V2云硬盘 - "ESSD2"为极速型SSD V2云硬盘 | | size | Integer | **参数解释** 云硬盘大小，单位为GiB。 **取值范围** 不涉及。 | | consistencygroup_id | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | bootable | String | **参数解释** 是否为启动云硬盘。 **取值范围** true：表示为启动云硬盘。 false：表示为非启动云硬盘。 | | metadata | Map\ | **参数解释** 云硬盘的metadata信息 ，调用方可以添加或删除metadata信息。 **取值范围** 当前部分key在EVS服务中有业务场景含义，这部分key的描述如下： - __system__cmkid metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 请求获取密钥ID的方法请参考："[查询密钥列表](https://support.huaweicloud.com/api-dew/ListKeys.html)"。 - __system__encrypted metadata中的表示加密功能的字段，0代表不加密，1代表加密。 不指定该字段时，云硬盘的加密属性与数据源保持一致，如果不是从数据源创建的场景，则默认不加密。 - hw:passthrough - true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 - false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 - 该字段不存在时，云硬盘默认为VBD类型。 - orderID metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。 | | updated_at | String | **参数解释** 云硬盘更新时间。 **取值范围** 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | 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\ | **参数解释** 云硬盘的标签。 单个云硬盘最多可以创建10个标签。 标签的key需要唯一。重复的key会做去重操作，即如果有重复的key，最终只保留一个作为有效的标签。 标签的key：String类型，最大长度36个字符。 由英文字母、数字、下划线、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 标签的value：String类型，最大长度43个字符，可以为空字符串。 由英文字母、数字、下划线、点、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 **取值范围** 不涉及。 | | wwn | String | **参数解释** 云硬盘挂载时的唯一标识。 **取值范围** 不涉及。 | | enterprise_project_id | String | **参数解释** 云硬盘上绑定的企业项目ID。 关于企业项目ID的获取及企业项目特性的详细信息，请参见："[企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html)"。 **取值范围** 不涉及。 | | serial_number | String | **参数解释** 云硬盘序列号。 只有SCSI类型的非双活云硬盘才会返回该字段，用于与虚拟机中的盘做对应关系。 **取值范围** 不涉及。 | | iops | [iops] object | **参数解释** 云硬盘的iops信息，云硬盘类型是ESSD2、GPSSD2才存在。 **取值范围** 不涉及。 | | throughput | [throughput] object | **参数解释** 云硬盘的吞吐量信息，云硬盘类型是GPSSD2才存在。 **取值范围** 不涉及。 | 表6Link | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释** 对应的快捷链接。 **取值范围** 不涉及。 | | rel | String | **参数解释** 快捷链接标记名称。 **取值范围** 不涉及。 | 表7Attachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围** 不涉及。 | 表8iops | 参数 | 参数类型 | 描述 | |:---|:---|:---| | frozened | Boolean | **参数解释** 冻结标签。 **取值范围** 不涉及。 | | id | String | **参数解释** 云硬盘iops标识。 **取值范围** 不涉及。 | | total_val | Integer | **参数解释** iops大小。 **取值范围** 不涉及。 | 表9throughput | 参数 | 参数类型 | 描述 | |:---|:---|:---| | frozened | Boolean | **参数解释** 冻结标签。 **取值范围** 不涉及。 | | id | String | **参数解释** 云硬盘吞吐量标识。 **取值范围** 不涉及。 | | total_val | Integer | **参数解释** 吞吐量大小。 **取值范围** 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 包含错误码和错误消息的对象 | 表11Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 描述错误消息的字符串 | #### 请求示例 - 查询云硬盘id为e92ba908-82f8-4728-b8cc-82f2f56bd461、40g42920-4243-420f-8bb2-a0bd7660fbd8、b1fd8dcc-dd67-4edf-b89e-87c3485112ec的云硬盘详情，从第1条记录开始查询，返回结果中的记录数不超过100个，返回结果按云硬盘大小排序。 ``` GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?ids=['e92ba908-82f8-4728-b8cc-82f2f56bd461', '40g42920-4243-420f-8bb2-a0bd7660fbd8', 'b1fd8dcc-dd67-4edf-b89e-87c3485112ec']&offset=0&limit=100&sort_key=size&sort_dir=asc ``` - 查询id为3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c的云服务器下的所有共享数据盘详情，返回结果按照升序排列。 ``` GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?server_id=3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c&multiattach=true&sort_dir=asc ``` #### 响应示例 **状态码：200** OK ``` { "count" : 1, "volumes" : [ { "attachments" : [ ], "availability_zone" : "az-dc-1", "bootable" : "false", "created_at" : "2016-05-25T02:42:10.856332", "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-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" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class ListVolumesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("")) .build(); ListVolumesRequest request = new ListVolumesRequest(); try { ListVolumesResponse response = client.listVolumes(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("")) \ .build() try: request = ListVolumesRequest() response = client.list_volumes(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := evs.EvsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) request := &model.ListVolumesRequest{} response, err := client.ListVolumes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EVS/sdk?api=ListVolumes)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。