盘类型列表"可以查到,即 volume_types参数说明表格中
6.1.8 查询所有云硬盘详情(废弃)
"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" : {
"message" : "XXXX", "code" : "XXX"
}}
状态码
状态码 描述
200 OK
400 Bad Request
错误码
请参见错误码。
6.1.8 查询所有云硬盘详情(废弃)
功能介绍
分类查询所有云硬盘详情。 注意: 该接口已废弃,请使用性能更佳的接口
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/os-vendor-volumes/detail
表6-57 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
表6-58 Query 参数
参数 是否必选 参数类型 描述
availability_zo
ne 否 String AZ信息
dedicated_sto
rage_id 否 String 专属存储池ID,可过滤出该专属
存储池下的所有云硬盘,必须精 确匹配
dedicated_sto
rage_name 否 String 专属存储池的名字,可过滤出该
专属存储池下的所有云硬盘,支
limit 否 Integer 返回结果个数限制,取值为大于
0的整数。默认值为1000。
marker 否 String 取值为上一页数据的最后一条记
录的id,返回值为该项后面的项
metadata 否 String 云硬盘元数据
multiattach 否 Boolean 是否为可共享云硬盘
name 否 String 云硬盘名称
offset 否 Integer 偏移量(偏移量为一个大于0小
于磁盘总个数的整数,表示查询 该偏移量后面的所有的卷)
service_type 否 String 服务类型,仅支持EVS、DSS、
DESS。
sort_dir 否 String 降序或升序(默认为“desc”)。
sort_key 否 String 返回结果按该关键字排序(支持
id,status,size,created_at等 关键字,默认为
“created_at”)
status 否 String 云硬盘状态
volume_type_i
d 否 String 云硬盘类型id
请求参数
表6-59 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String Token的有效期为24小时,需要 使用一个Token鉴权时,可以先 缓存起来,避免频繁调用。
响应参数
状态码: 200
表6-60 响应 Body 参数
参数 参数类型 描述
count Integer 查询到的云硬盘总数量,不受分页影响。
volumes Array of DiskDetail objects
查询请求返回的云硬盘列表。
volumes_links Array of Link
objects 云硬盘列表查询位置标记。如果本次查询只返回 部分列表信息时,会返回查询到的当前磁盘mark 标记的url,可以继续使用这个url查询剩余列表信 息。
表6-61 DiskDetail
参数 参数类型 描述
attachments Array of DiskAttachm ent objects
云硬盘的挂载信息。
availability_zo
ne String 云硬盘所属的AZ信息。
bootable String 是否为可启动云硬盘。
consistencygr
oup_id String 所属一致性组ID。
count String 已查询出的云硬盘列表中云硬盘的 数量 created_at String 云硬盘创建时间。
时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
参数 参数类型 描述 dedicated_sto
rage_id String 云硬盘所属的专属存储池ID dedicated_sto
rage_name String 云硬盘所属的专属存储池的名称 description String 云硬盘描述。
encrypted Boolean 是否为加密云硬盘。
enterprise_pro
ject_id String 云硬盘上绑定的企业项目ID。 当前云硬盘服务不 支持该字段
id String 云硬盘ID。
links Array of Link
objects 云硬盘URI自描述信息。
metadata DiskMetadat
a object 元数据。
multiattach Boolean 创建共享云硬盘的信息
name String 云硬盘名称。
os-vendorextend ed:lock_check _endpoint
String 检查锁是否有效的回调链接
os-vendorextend ed:lock_scene
String 云硬盘的加锁类型
os-vendorextend ed:lock_sourc e_id
String 云硬盘的锁归属的资源ID
os-vendorextend ed:lock_sourc e_service
String 云硬盘的锁归属的服务类型
os-vol-hostattr:host String 云硬盘所在的主机
os-vol-migstatusattr:
migstat
String 预留属性
os-vol-migstatusattr:
name_id
String 预留属性
参数 参数类型 描述 os-voltenantattr:
tenant_id
String 云硬盘所属的租户ID
os-volumereplica tion:driver_da ta
String 预留属性
os-volumereplica tion:extended _status
String 预留属性
replication_st
atus String 预留属性
service_type String 服务类型,结果为EVS、DSS、 DESS。
shareable Boolean 是否为可共享云硬盘。
size Integer 云硬盘大小。
snapshot_id String 快照ID。
source_volid String 源云硬盘ID。
status String 云硬盘状态,请参见 云硬盘状态。
tags Object 云硬盘的标签。
如果云硬盘有标签,则会有该字段,否则该字段 为空。
updated_at String 云硬盘更新时间。
user_id String 预留属性 volume_imag
e_metadata Object 如果云硬盘是从镜像创建的则会有该字段,否则 该字段为空。 说明: 关于
“volume_image_metadata”字段的详细说明,
具体请参见查询镜像详情(OpenStack原生)。
volume_type String 云硬盘类型。
目前支持"SATA","SAS","GPSSD"和"SSD"四 种。
● "SATA"为普通IO云硬盘
● "SAS"为高IO云硬盘
● "GPSSD"为通用型SSD云硬盘
● "SSD"为超高IO云硬盘
wwn String 云硬盘挂载时的唯一标识
表6-62 DiskAttachment
参数 参数类型 描述
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-63 DiskMetadata
参数 参数类型 描述
__system__cm
kid String metadata中的加密cmkid字段,与
__system__encrypted配合表示需要加密,cmkid 长度固定为36个字节。
__system__en
crypted String metadata中的表示加密功能的字段,0代表不加 密,1代表加密。 该字段不存在时,云硬盘默认 为不加密。
full_clone String 从快照创建云硬盘时,字段的值为0表示使用link 克隆方式。
hw:passthrou
gh String metadata中的表示云硬盘设备类型的字段。
● true表示云硬盘的设备类型为SCSI类型,即允 许ECS操作系统直接访问底层存储介质。支持 SCSI锁命令。
● false表示云硬盘的设备类型为VBD类型,即为 默认类型,VBD只能支持简单的SCSI读写命 令。
● 该字段不存在时,云硬盘默认为VBD类型。
表6-64 Link
参数 参数类型 描述
参数 参数类型 描述
rel String 快捷链接标记名称。
状态码: 400
表6-65 响应 Body 参数
参数 参数类型 描述
error Error object 出现错误时,返回的错误信息
表6-66 Error
参数 参数类型 描述
code String 出现错误时,返回的错误码。 错误码和其对应的 含义请参考错误码说明。
message String 错误提示信息。
请求示例
"availability_zone" : "xxx", "bootable" : "false", "consistencygroup_id" : null,"created_at" : "2016-05-25T02:42:10.856332", "description" : null,
"encrypted" : false,
"id" : "b104b8db-170d-441b-897a-3c8ba9c5a214", "links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/
b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/
b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "bookmark"
} ],
"metadata" : {
"__openstack_region_name" : "pod01.xxx", "a" : "b",
"quantityGB" : "1",
"volInfoUrl" : "fusionstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D"
},
"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
错误码
请参见错误码。