功能介绍
查询 云硬盘 快照详情列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/cloudsnapshots/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 获取方法请参见"获取项目ID"。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量。 说明:分页查询快照时使用，与limit配合使用。假如共有30个快照，设置offset为11，limit为10，即为从第12个快照开始查询，一次最多可读取10个快照。 |
|
limit |
否 |
Integer |
返回结果个数限制，值为大于0的整数。默认值为1000。 |
|
name |
否 |
String |
云硬盘快照名称。最大支持255个字节。 |
|
status |
否 |
String |
云硬盘快照状态，具体请参见云硬盘快照状态。 |
|
volume_id |
否 |
String |
快照所属云硬盘的ID。 |
|
availability_zone |
否 |
String |
快照所属云硬盘的可用区。 |
|
id |
否 |
String |
指定快照id进行过滤。可以传入多个id过滤查询，格式：id=id1&id=id2&id=id3 |
|
dedicated_storage_name |
否 |
String |
专属存储的名称。 |
|
dedicated_storage_id |
否 |
String |
专属存储ID。 |
|
service_type |
否 |
String |
服务类型。仅支持EVS、DSS、DESS。 |
|
ent erp rise_project_id |
否 |
String |
指定企业项目id进行过滤。 传入“all_granted_eps”，代表查询权限范围内的所有企业项目下的云硬盘。 说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参考："企业管理用户指南"。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
快照的总数量，不受limi参数的影响。 |
|
snapshots |
快照信息。 |
|
|
snapshots_links |
云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段，返回该字段表示本次查询只查出了部分云硬盘快照信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
云硬盘快照ID。 |
|
status |
String |
云硬盘快照的状态。 |
|
name |
String |
云硬盘快照名称。 |
|
description |
String |
云硬盘快照描述信息。 |
|
created_at |
String |
云硬盘快照创建时间。 |
|
updated_at |
String |
云硬盘快照更新时间。 |
|
metadata |
Map<String,String> |
云硬盘快照的元数据信息。 |
|
volume_id |
String |
快照所属的云硬盘。 |
|
size |
Integer |
云硬盘快照大小。 |
|
os-extended-snapshot-attributes:project_id |
String |
项目ID。 |
|
os-extended-snapshot-attributes:progress |
String |
快照进度。 |
|
dedicated_storage_id |
String |
专属存储ID。 |
|
dedicated_storage_name |
String |
专属存储名称。 |
|
service_type |
String |
服务类型。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
出现错误时，返回的错误信息，具体请参见 error参数说明。 |
请求示例
GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail
https://{endpoint}/v2/{project_id}/cloudsnapshots/detail
响应示例
状态码： 200
OK
{
"count" : 3,
"snapshots_links" : [ {
"href" : "https://{endpoint}/v2/20a68d6b7a124ae2b6b8a22046ee5966/
cloudsnapshots/detail?limit=1&marker=fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
"rel" : "next"
} ],
"snapshots" : [ {
"status" : "available",
"updated_at" : "2018-06-06T10:58:47.349051",
"volume_id" : "f687bd70-37b3-4f00-a900-0ba1cfaa5196",
"id" : "fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
"size" : 1,
"os-extended-snapshot-attributes:progress" : "100%",
"name" : "test03",
"os-extended-snapshot-attributes:project_id" : "20a68d6b7a124ae2b6b8a22046ee5966",
"service_type" : "EVS",
"created_at" : "2018-05-30T03:14:44.457975",
"metadata" : { }
} ]
}
状态码： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
错误码
请参见错误码。
