盘类型列表"可以查到,即 volume_types参数说明表格中
6.1.9 查询单个云硬盘详情
"name" : "zjb_u25_test",
"os-vol-host-attr:host" : "pod01.xxx#SATA", "volume_image_metadata" : { },
"os-vol-mig-status-attr:migstat" : null, "os-vol-mig-status-attr:name_id" : null,
"os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f", "os-volume-replication:extended_status" : null,
"replication_status" : "disabled", "multiattach" : false,
"size" : 1,
"snapshot_id" : null, "source_volid" : null, "status" : "available",
"updated_at" : "2016-05-25T02:42:22.341984", "user_id" : "b0524e8342084ef5b74f158f78fc3049", "volume_type" : "SATA",
"service_type" : "EVS", "dedicated_storage_id" : null, "dedicated_storage_name" : null,
"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" : {
400 Bad Request
错误码
请参见错误码。
6.1.9 查询单个云硬盘详情
功能介绍
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/cloudvolumes/{volume_id}
表6-67 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。 获取方法请参见"获取
项目ID"。
volume_id 是 String 云硬盘ID。
请求参数
表6-68 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)。
响应参数
状态码: 200
表6-69 响应 Body 参数
参数 参数类型 描述
volume VolumeDetai
l object 云硬盘详情。
表6-70 VolumeDetail
参数 参数类型 描述
id String 云硬盘的ID。
links Array of Link
objects 云硬盘URI自描述信息。
参数 参数类型 描述
name String 云硬盘名称。
status String 云硬盘状态,请参见云硬盘状态。
attachments Array of Attachment objects
云硬盘的挂载信息。
availability_zo
ne 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_imag
e_metadata Map<String,O
bject> 云硬盘镜像的元数据。
说明关于“volume_image_metadata”字段的详细说明,
具体请参见:"查询镜像详情"。
volume_type String 云硬盘类型。 目前支持"SATA","SAS",
"GPSSD"和"SSD"四种。
● "SATA"为普通IO云硬盘
● "SAS"为高IO云硬盘
● "GPSSD"为通用型SSD云硬盘
● "SSD"为超高IO云硬盘 size Integer 云硬盘大小,单位为GB。
consistencygr
oup_id String 预留属性。
bootable String 是否为启动云硬盘。 true:表示为启动云硬盘。
false:表示为非启动云硬盘。
metadata VolumeMeta
data object 云硬盘的元数据。
updated_at String 云硬盘更新时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
参数 参数类型 描述 replication_st
atus String 预留属性。
os-volume-replication:ext ended_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_sto
rage_id String 云硬盘所属的专属存储池ID。
dedicated_sto
rage_name String 云硬盘所属的专属存储池的名称。
tags Map<String,St
ring> 云硬盘的标签。 如果云硬盘有标签,则会有该字 段,否则该字段为空。
wwn String 云硬盘挂载时的唯一标识。
enterprise_pro
ject_id String 云硬盘上绑定的企业项目ID。
说明关于企业项目ID的获取及企业项目特性的详细信息,请
参见:"企业管理用户指南"。
serial_number String 云硬盘序列号。 只有SCSI类型的非双活卷才会返 回该字段,用于与虚拟机中的盘做对应关系。
表6-71 Link
参数 参数类型 描述
href String 对应的快捷链接。
rel String 快捷链接标记名称。
表6-72 Attachment
参数 参数类型 描述
attached_at String 挂载的时间信息。
时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_i
d String 挂载信息对应的ID。
device String 挂载点。
host_name String 云硬盘挂载到的云服务器对应的物理主机的名 称。
id String 挂载的资源ID。
server_id String 云硬盘挂载到的云服务器的 ID。
volume_id String 云硬盘ID。
表6-73 VolumeMetadata
参数 参数类型 描述
__system__cm
kid String metadata中的加密cmkid字段,与
__system__encrypted配合表示需要加密,cmkid 长度固定为36个字节。
说明请求获取密钥ID的方法请参考:"查询密钥列表"。
__system__en
crypted String metadata中的表示加密功能的字段,0代表不加 密,1代表加密。 不指定该字段时,云硬盘的加 密属性与数据源保持一致,如果不是从数据源创 建的场景,则默认不加密。
full_clone String 从快照创建云硬盘时的创建方式。
● 0表示使用链接克隆方式。
● 1表示使用全量克隆方式。
hw:passthrou
gh String ● true表示云硬盘的设备类型为SCSI类型,即允 许ECS操作系统直接访问底层存储介质。支持 SCSI锁命令。
● false表示云硬盘的设备类型为VBD (虚拟块存 储设备 , Virtual Block Device)类型,即为默 认类型,VBD只能支持简单的SCSI读写命令。
● 该字段不存在时,云硬盘默认为VBD类型。
orderID String metadata中的表示云硬盘计费类型的字段。 当 该字段有值时,表示该云硬盘的计费类型为包周 期计费,否则计费类型为按需计费。
状态码: 400
表6-74 响应 Body 参数
参数 参数类型 描述
error Error object 出现错误时,返回的错误信息
表6-75 Error
参数 参数类型 描述
code String 出现错误时,返回的错误码。 错误码和其对应的 含义请参考错误码说明。
message String 错误提示信息。
请求示例
GET https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}
响应示例
"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", "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",
"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"
}}
状态码: 400 Bad Request
{ "error" : {
"message" : "XXXX", "code" : "XXX"
}}
状态码
状态码 描述
200 云硬盘的信息。
400 Bad Request
错误码
请参见错误码。