文档首页> 云硬盘 EVS> API参考> OpenStack Cinder API v2> 云硬盘快照> 查询云硬盘快照详细信息列表
更新时间:2022-01-22 GMT+08:00
分享

查询云硬盘快照详细信息列表

功能介绍

查询云硬盘快照详细列表信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/snapshots/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。 获取方法请参见"获取项目ID"。

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone

String

云硬盘快照对应的云硬盘所在的可用区。

limit

Integer

返回结果个数限制。

最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。

当租户所有的快照数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例:

GET /v2/xxx/snapshots/detail?limit=50,表示查询第1~50个快照。GET /v2/xxx/snapshots/detail?offset=50&limit=50,表示查询第51~100个快照。

marker

String

分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。

name

String

云硬盘快照名称。最大支持255个字节。

offset

Integer

偏移量。

说明:

分页查询快照时使用,与limit配合使用。假如共有30个快照, 设置offset为11,limit为10,即为从第12个快照开始查询, 一次最多可读取10个快照。

status

String

云硬盘快照状态,具体请参见云硬盘快照状态

volume_id

String

云硬盘快照对应的云硬盘ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

snapshots_links

Array of Link objects

云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段,返回该字段表示本次查询只查出了部分云硬盘快照信息。

snapshots

Array of SnapshotDetail objects

快照信息。

表6 SnapshotDetail

参数

参数类型

描述

id

String

云硬盘快照ID。

name

String

云硬盘快照名称。

名称以autobk_snapshot_为前缀的快照是创建云硬盘备份时系统自动创建的,请不要进行“删除云硬盘快照”和“回滚快照到云硬盘”操作。

description

String

云硬盘快照描述信息。

created_at

String

云硬盘快照创建时间。

时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

update_at

String

云硬盘快照更新时间

metadata

Map<String,String>

云硬盘快照的元数据信息

volume_id

String

快照所属的云硬盘ID。

size

String

云硬盘快照大小,单位为GB。

status

String

云硬盘快照的状态,具体请参见云硬盘快照状态

os-extended-snapshot-attributes:progress

String

预留属性。

os-extended-snapshot-attributes:project_id

String

租户ID。租户ID就是项目ID。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

Error object

出现错误时,返回的错误信息。

表8 Error

参数

参数类型

描述

code

String

出现错误时,返回的错误码。

错误码和其对应的含义请参考错误码说明

message

String

出现错误时,返回的错误消息。

请求示例

GET https://{endpoint}/v2/{project_id}/snapshots/detail

响应示例

状态码: 200

OK

{
  "snapshots" : [ {
    "status" : "available",
    "os-extended-snapshot-attributes:progress" : "100%",
    "description" : null,
    "created_at" : "2013-06-19T07:15:29.000000",
    "metadata" : { },
    "volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d",
    "os-extended-snapshot-attributes:project_id" : "d6c277ba8820452e83df36f33c9fa561",
    "size" : 5,
    "id" : "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
    "name" : "name_xx2-snap",
    "updated_at" : null
  }, {
    "status" : "available",
    "os-extended-snapshot-attributes:progress" : "100%",
    "description" : null,
    "created_at" : "2013-06-19T09:08:08.000000",
    "metadata" : { },
    "volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d",
    "os-extended-snapshot-attributes:project_id" : "d6c277ba8820452e83df36f33c9fa561",
    "size" : 5,
    "id" : "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
    "name" : "name_xx2-snap",
    "updated_at" : null
  } ]
}

状态码: 400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读