# 查询单个云硬盘详情 - CinderShowVolumeV3 #### 功能介绍 查询单个云硬盘详情。 #### 调用方法 请参见[如何调用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}/volumes/{volume_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 | | volume_id | 是 | String | 云硬盘ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | volume | [CinderVolumeDetail] object | **参数解释** 查询请求返回的云硬盘。 **取值范围** 不涉及。 | 表4CinderVolumeDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 [VolumeAttachment] objects | **参数解释** 是否挂载信息。 **取值范围** 不涉及。 | | availability_zone | String | **参数解释** 云硬盘所属可用区。 **取值范围** 不涉及。 | | source_volid | String | **参数解释** 源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。 **取值范围** 不涉及。 | | snapshot_id | String | **参数解释** 快照ID，如果是从快照创建，则有值。 **取值范围** 不涉及。 | | description | String | **参数解释** 云硬盘描述。 **取值范围** 不涉及。 | | bootable | String | **参数解释** 是否为启动云硬盘。 **取值范围** - true：表示为启动云硬盘。 - false：表示为非启动云硬盘。 | | 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云硬盘 | | metadata | [VolumeMetadata] object | **参数解释** 云硬盘的元数据。 如果元数据中不包含hw:passthrough字段，云硬盘默认为VBD类型。 如果元数据中不包含__system__encrypted字段，云硬盘默认为不加密。 **取值范围** 不涉及。 | | size | Integer | **参数解释** 云硬盘大小，单位为GiB。 **取值范围** 不涉及。 | | shareable | Boolean | **参数解释** 是否为可共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。 **取值范围** 不涉及。 | | multiattach | Boolean | **参数解释** 是否为可共享云硬盘。 **取值范围** - true：表示为共享云硬盘。 - false：表示为普通云硬盘。 | | os-vol-tenant-attr:tenant_id | String | **参数解释** 云硬盘所属的项目ID。 **取值范围** 不涉及。 | | volume_image_metadata | Object | **参数解释** 云硬盘镜像的元数据。 关于"volume_image_metadata"字段的详细说明，具体请参见："[查询镜像详情](https://support.huaweicloud.com/api-ims/ims_03_0703.html)"。 **取值范围** 不涉及。 | | os-vol-host-attr:host | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | os-volume-replication:extended_status | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | consistencygroup_id | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | iops | [iops] object | **参数解释** 云硬盘的iops信息，云硬盘类型是ESSD2、GPSSD2才返回。 **取值范围** 不涉及。 | | throughput | [throughput] object | **参数解释** 云硬盘的吞吐量信息，云硬盘类型是GPSSD2才返回。 **取值范围** 不涉及。 | | updated_at | String | **参数解释** 云硬盘更新时间。 **取值范围** 不涉及。 | | replication_status | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | user_id | String | **参数解释** 预留属性。 **取值范围** 不涉及。 | | encrypted | Boolean | **参数解释** 预留属性。 **取值范围** 不涉及。 | | snapshot_policy_id | String | **参数解释** 云硬盘绑定的快照策略ID。 **取值范围** 不涉及。 | 表5Link | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释** 对应的快捷链接。 **取值范围** 不涉及。 | | rel | String | **参数解释** 快捷链接标记名称。 **取值范围** 不涉及。 | 表6VolumeAttachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围** 不涉及。 | 表7VolumeMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | __system__cmkid | String | **参数解释** metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 **取值范围** 请参考 [查询密钥列表](https://support.huaweicloud.com/api-dew/ListKeys.html)，通过HTTPS请求获取密钥ID。 | | __system__encrypted | String | **参数解释** metadata中的表示加密功能的字段。 该字段不存在时，云硬盘默认为不加密。 **取值范围** - 0：表示不加密。 - 1：表示加密。 | | hw:passthrough | String | **参数解释** metadata中的表示云硬盘设备类型的字段。 该字段不存在时，云硬盘默认为VBD类型。 **取值范围** - true：表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 - false：表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 | 表8iops | 参数 | 参数类型 | 描述 | |:---|:---|:---| | frozened | Boolean | **参数解释** 冻结标签。 **取值范围** 不涉及。 | | id | String | **参数解释** 云硬盘iops标识。 **取值范围** 不涉及。 | | total_val | Integer | **参数解释** iops大小。 **取值范围** 不涉及。 | | volume_id | String | **参数解释** 云硬盘ID。 **取值范围** 不涉及。 | 表9throughput | 参数 | 参数类型 | 描述 | |:---|:---|:---| | frozened | Boolean | **参数解释** 冻结标签。 **取值范围** 不涉及。 | | id | String | **参数解释** 云硬盘吞吐量标识。 **取值范围** 不涉及。 | | total_val | Integer | **参数解释** 吞吐量大小。 **取值范围** 不涉及。 | | volume_id | String | **参数解释** 云硬盘ID。 **取值范围** 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误信息。 **取值范围** 不涉及。 | 表11Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请[参考错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/{project_id}/volumes/{volume_id} https://{endpoint}/v3/{project_id}/volumes/{volume_id} ``` #### 响应示例 **状态码：200** OK ``` { "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "bookmark" } ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "az-dc-1#SSD", "encrypted" : false, "multiattach" : true, "updated_at" : "2016-02-03T02:19:29.895237", "os-volume-replication:extended_status" : null, "replication_status" : "disabled", "snapshot_id" : null, "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "volume_image_metadata" : null, "os-vol-mig-status-attr:migstat" : null, "metadata" : { }, "status" : "error_restoring", "description" : "auto-created_from_restore_from_backup", "source_volid" : null, "consistencygroup_id" : null, "os-vol-mig-status-attr:name_id" : null, "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "volume_type" : null } } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "XXX" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。