查询硬盘详情 - ShowVolume

功能介绍

查询硬盘详情。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/cloudvolumes/{volume_id}

表1 路径参数
参数	是否必选	参数类型	描述
volume_id	是	String	磁盘ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
volume	Volume object	硬盘对象。

表4 Volume
参数	参数类型	描述
id	String	硬盘ID。
status	String	磁盘状态。云硬盘状态，请参见磁盘状态。
size	Integer	磁盘大小。
availability_zone	String	硬盘所属的AZ信息。
attachments	Array of Attachment objects	硬盘的挂载信息。
name	String	磁盘名称。
description	String	描述。
volume_type	String	云硬盘类型。取值范围：目前支持"SATA"，"SAS"，"GPSSD"，"SSD"。 "SATA"为普通IO云硬盘 "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘
bootable	String	是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。
encrypted	Boolean	显示该卷是否已被加密。
multiattach	Boolean	磁盘是否多挂载。
metadata	Map<String,String>	硬盘的元数据。
site_id	String	磁盘所在站点的ID。
created_at	String	磁盘创建时间。
updated_at	String	磁盘更新时间。

表5 Attachment
参数	参数类型	描述
attachment_id	String	挂载信息对应的ID。
device	String	挂载点。
host_name	String	边缘硬盘挂载到的边缘实例对应的物理主机的名称。
id	String	挂载的资源ID。
server_id	String	硬盘挂载到的边缘实例的ID。
volume_id	String	磁盘ID。

请求示例

GET https://{endpoint}/v1/cloudvolumes/48eb38f5-da62-42f3-a19e-f4fe58f92e5e

响应示例

状态码：200

{
  "volume" : {
    "id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e",
    "status" : "in-use",
    "size" : 40,
    "availability_zone" : "edgecloud-site3",
    "attachments" : [ {
      "attachment_id" : "83e647b7-01a4-4c38-9108-ed83989f0a9a",
      "device" : "/dev/vda",
      "host_name" : "",
      "id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e",
      "server_id" : "51aff40b-3adf-4048-b18e-f11cbd76b02f",
      "volume_id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e"
    } ],
    "name" : "IEC-zhongshan01-test-edgestackEdge1-0002-volume-0000",
    "description" : "",
    "volume_type" : "SATA",
    "metadata" : {
      "attached_mode" : "rw",
      "readonly" : "False"
    },
    "bootable" : "true",
    "encrypted" : false,
    "multiattach" : false
  }
}