文档首页/ 云硬盘 EVS/ API参考/ 历史API/ Cinder API/ 云硬盘管理/ 查询单个云硬盘详情（废弃） - CinderShowVolumeV1
更新时间：2025-11-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个云硬盘详情（废弃） - CinderShowVolumeV1

功能介绍

查询单个云硬盘的详细信息。该接口已废弃，请使用性能更佳的接口。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/volumes/{volume_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

volume_id

是

String

云硬盘ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

volume

CinderVolumeDetail object

参数解释

查询请求返回的云硬盘。

取值范围

不涉及。
表3 CinderVolumeDetail

参数

参数类型

描述

id

String

参数解释

云硬盘ID。

取值范围

不涉及。

links

Array of Link objects

参数解释

云硬盘uri自描述信息。

取值范围

不涉及。

name

String

参数解释

云硬盘名称。

取值范围

不涉及。

status

String

参数解释

云硬盘状态，具体请参见云硬盘状态。

取值范围

不涉及。

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"六种。

  • "SATA"为普通IO云硬盘(已售罄)

  • "SAS"为高IO云硬盘

  • "GPSSD"为通用型SSD云硬盘

  • "SSD"为超高IO云硬盘

  • "ESSD"为极速型SSD云硬盘

  • "GPSSD2"为通用型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”字段的详细说明，具体请参见："查询镜像详情"。

取值范围

不涉及。

os-vol-host-attr:host

String

参数解释

预留属性。

取值范围

不涉及。

os-volume-replication:extended_status

String

参数解释

预留属性。

取值范围

不涉及。

consistencygroup_id

String

参数解释

预留属性。

取值范围

不涉及。

iops

iops object

参数解释

云硬盘的iops信息，云硬盘类型是GPSSD2才返回。

取值范围

不涉及。

throughput

throughput object

参数解释

云硬盘的吞吐量信息，云硬盘类型是GPSSD2才返回。

取值范围

不涉及。

updated_at

String

参数解释

云硬盘更新时间。

取值范围

不涉及。

replication_status

String

参数解释

预留属性。

取值范围

不涉及。

user_id

String

参数解释

预留属性。

取值范围

不涉及。

encrypted

Boolean

参数解释

预留属性。

取值范围

不涉及。

snapshot_policy_id

String

参数解释

云硬盘绑定的快照策略ID。

取值范围

不涉及。
表4 Link

参数

参数类型

描述

href

String

参数解释

对应的快捷链接。

取值范围

不涉及。

rel

String

参数解释

快捷链接标记名称。

取值范围

不涉及。
表5 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。

取值范围

不涉及。
表6 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读写命令。
表7 iops

参数

参数类型

描述

frozened

Boolean

参数解释

冻结标签。

取值范围

不涉及。

id

String

参数解释

云硬盘iops标识。

取值范围

不涉及。

total_val

Integer

参数解释

iops大小。

取值范围

不涉及。

volume_id

String

参数解释

云硬盘ID。

取值范围

不涉及。
表8 throughput

参数

参数类型

描述

frozened

Boolean

参数解释

冻结标签。

取值范围

不涉及。

id

String

参数解释

云硬盘吞吐量标识。

取值范围

不涉及。

total_val

Integer

参数解释

吞吐量大小。

取值范围

不涉及。

volume_id

String

参数解释

云硬盘ID。

取值范围

不涉及。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时，返回的错误信息。

取值范围

不涉及。
表10 Error

参数

参数类型

描述

code

String

参数解释

出现错误时，返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明。

message

String

参数解释

出现错误时，返回的错误消息。

取值范围

不涉及。

请求示例

无

响应示例

状态码：200

OK

{
  "volume" : {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "os-vol-host-attr:host" : "db-rabbitmq201#LVM_iSCSI",
    "encrypted" : false,
    "id" : "da4f9c7a-c275-4bc9-80c4-76c7d479a218",
    "size" : 1,
    "os-vol-tenant-attr:tenant_id" : "3dab0aaf682849678a94ec7b5a3af2ce",
    "metadata" : { },
    "status" : "available",
    "display_name" : "test",
    "bootable" : "false",
    "created_at" : "2014-12-18T17:14:38.000000",
    "volume_type" : "SATA",
    "multiattach" : false
  }
}

状态码：400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 云硬盘管理