查询单个云硬盘详情

功能介绍

查询单个云硬盘的详细信息。

调试

您可以在中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

• URI格式

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

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID。 获取方法请参见获取项目ID。
  volume_id	是	云硬盘ID。

请求消息

• 请求样例

  GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/b104b8db-170d-441b-897a-3c8ba9c5a214

响应消息

• 响应参数

  参数	参数类型	描述
  volume	Object	查询请求返回的云硬盘，请参见•volume参数说明。
  error	Object	出现错误时，返回的错误信息，具体请参见 error参数说明。

• volume参数说明

  参数	参数类型	描述
  id	String	云硬盘的ID。
  links	Array of objects	云硬盘URI自描述信息，请参见•links参数说明。
  name	String	云硬盘名称。
  status	String	云硬盘状态，具体请参见云硬盘状态。
  attachments	Array of objects	云硬盘的挂载信息，请参见•attachments参数说明。
  availability_zone	String	云硬盘所属的AZ信息。
  count	String	已查询出的云硬盘列表中云硬盘的 数量
  source_volid	String	源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。
  snapshot_id	String	快照ID，如果是从快照创建，则有值。
  description	String	云硬盘描述。
  os-vol-tenant-attr:tenant_id	String	云硬盘所属的租户ID。租户ID就是项目ID。
  volume_image_metadata	Object	云硬盘镜像的元数据。 说明： 关于“volume_image_metadata”字段的详细说明，具体请参见“镜像服务API参考”中的“查询镜像详情（OpenStack原生）”章节。
  dedicated_storage_id	String	云硬盘所属的专属存储池ID
  dedicated_storage_name	String	云硬盘所属的专属存储池的名称
  enterprise_project_id	String	云硬盘上绑定的企业项目ID。 当前云硬盘服务不支持该字段
  created_at	String	云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  volume_type	String	云硬盘类型。 目前支持“SATA”和“SSD”。 “SSD”为超高IO云硬盘 “SATA”为普通IO云硬盘
  size	Integer	云硬盘大小，单位为GB。
  bootable	String	是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。
  metadata	Object	云硬盘的元数据，请参见•metadata参数说明。 如果元数据中不包含hw:passthrough字段，云硬盘默认为VBD类型。
  os-vol-host-attr:host	String	预留属性。
  encrypted	Boolean	是否为加密云硬盘。
  updated_at	String	云硬盘更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  os-volume-replication:driver_data	String	预留属性
  os-volume-replication:extended_status	String	预留属性。
  replication_status	String	预留属性。
  os-vol-mig-status-attr:migstat	String	预留属性。
  consistencygroup_id	String	预留属性。
  os-vol-mig-status-attr:name_id	String	预留属性。
  shareable	String	是否为共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。
  user_id	String	预留属性。
  multiattach	Boolean	是否为共享云硬盘。 true：表示为共享云硬盘。 false：表示为非共享云硬盘。
  dedicated_storage_id	String	云硬盘所属的专属存储池ID。
  dedicated_storage_name	String	云硬盘所属的专属存储池的名称。
  tags	Object	云硬盘的标签。 如果云硬盘有标签，则会有该字段，否则该字段为空。
  wwn	String	云硬盘挂载时的唯一标识。

• links参数说明

  参数	参数类型	描述
  href	String	对应的快捷链接。
  rel	String	快捷链接标记名称。

• attachments参数说明

  参数	参数类型	描述
  server_id	String	云硬盘挂载到的云服务器的ID。
  attachment_id	String	挂载信息对应的ID。
  attached_at	String	挂载的时间信息。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  host_name	String	云硬盘挂载到的云服务器对应的物理主机的名称。
  volume_id	String	云硬盘ID。
  device	String	挂载点。
  id	String	挂载的资源ID。

• metadata参数说明

  参数	参数类型	描述
  __system__encrypted	String	metadata中的表示加密功能的字段。 0代表不加密。 1代表加密。 该字段不存在时，云硬盘默认为不加密。
  __system__cmkid	String	metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。
  hw:passthrough	String	metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。
  full_clone	String	从快照创建云硬盘时，字段的值为0表示使用link克隆方式。

• error参数说明

  参数	参数类型	描述
  message	String	出现错误时，返回的错误消息。
  code	String	出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码。

• 响应样例

  {
      "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": {}, 
          "tags": {
              "key1": "value1", 
              "key2": "value2"
          }, 
          "status": "available", 
          "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, 
          "service_type": "EVS", 
          "dedicated_storage_id": null, 
          "dedicated_storage_name": null, 
          "wwn": " 688860300000d136fa16f48f05992360"
      }
  }

  或

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

  其中error是泛指的错误，有badrequest、itemNotFound等，如报错为：

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

状态码

• 正常

  200

错误码

请参考错误码。