查询快照详情列表
功能介绍
查询快照详情列表。标准快照当前只在部分区域支持，具体的区域列表请参见"功能总览"中快照页签下的区域信息。
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/snapshots/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目ID。 约束限制 不涉及。 取值范围 获取方法请参见"获取项目ID"。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
参数解释 分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
volume_id |
否 |
String |
参数解释 快照对应的云硬盘ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
availability_zone |
否 |
String |
参数解释 快照对应的云硬盘所在的可用区。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
limit |
否 |
String |
参数解释 返回结果个数限制。 当租户所有的快照数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v2/xxx/snapshots/detail?limit=50，表示查询第1~50个快照。GET /v2/xxx/snapshots/detail?offset=50&limit=50，表示查询第51~100个快照。 约束限制 不涉及。 取值范围 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 默认取值 不涉及。 |
|
name |
否 |
String |
参数解释 快照名称。 约束限制 最大支持255个字符。 取值范围 不涉及。 默认取值 不涉及。 |
|
offset |
否 |
String |
参数解释
说明：
分页查询快照时使用，与limit配合使用。假如共有30个快照，
设置offset为11，limit为10，即为从第12个快照开始查询， 一次最多可读取10个快照。 偏移量。 分页查询快照时使用，与limit配合使用。假如共有30个快照， 设置offset为11，limit为10，即为从第12个快照开始查询， 一次最多可读取10个快照。 约束限制 与limit配合使用。 取值范围 不涉及。 默认取值 不涉及。 |
|
status |
否 |
String |
参数解释 快照状态。 约束限制 不涉及。 取值范围 具体请参见云硬盘快照状态。 默认取值 不涉及。 |
|
sort_key |
否 |
String |
参数解释 返回结果按该关键字排序。 约束限制 不涉及。 取值范围 支持id，status，created_at等关键字。 默认取值 默认为“created_at”。 |
|
sort_dir |
否 |
String |
参数解释 返回结果按照降序或升序排列，默认为“desc”。 约束限制 不涉及。 取值范围 降序：desc 升序：asc 默认取值 desc |
|
id |
否 |
String |
参数解释 快照ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
ids |
否 |
String |
参数解释 快照id列表，多个id直接用,号隔开，格式为ids=id1,id2,...,idx。返回有效id对应的快照信息，无效的id会被忽略。 约束限制 最多支持一次查询60个id。 如果“id”和“ids”查询参数同时存在，“id”会被忽略。 取值范围 不涉及。 默认取值 不涉及。 |
|
snapshot_type |
否 |
String |
参数解释 快照来源。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
enterprise_project_id |
否 |
String |
参数解释 快照的企业项目ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
tag_key |
否 |
String |
参数解释 快照标签的key。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
tags |
否 |
String |
参数解释 快照标签的key/value对，例如{"key1":"value1"}。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
snapshot_chain_id |
否 |
String |
参数解释 快照链ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
snapshot_group_id |
否 |
String |
参数解释 快照一致性组ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 约束限制 不涉及。 取值范围 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 默认取值 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
snapshots |
Array of SnapshotDetailV5 objects |
参数解释 快照信息。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释 云硬盘快照ID。 取值范围 不涉及。 |
|
name |
String |
参数解释 云硬盘快照名称。 名称以autobk_snapshot_为前缀的快照是创建云硬盘备份时系统自动创建的，请不要进行“删除云硬盘快照”和“回滚快照到云硬盘”操作。 取值范围 不涉及。 |
|
description |
String |
参数解释 云硬盘快照描述信息。 取值范围 不涉及。 |
|
created_at |
String |
参数解释 云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX 取值范围 不涉及。 |
|
updated_at |
String |
参数解释 云硬盘快照更新时间。 取值范围 不涉及。 |
|
volume_id |
String |
参数解释 快照所属的云硬盘ID。 取值范围 不涉及。 |
|
size |
String |
参数解释 云硬盘快照大小，单位为GiB。 取值范围 不涉及。 |
|
status |
String |
参数解释 云硬盘快照的状态。 取值范围 具体请参见云硬盘快照状态。 |
|
project_id |
String |
参数解释 项目ID。 取值范围 不涉及。 |
|
enterprise_project_id |
String |
参数解释 快照所属的企业项目ID。 取值范围 不涉及。 |
|
encrypted |
Boolean |
参数解释 是否为加密快照。 取值范围 不涉及。 |
|
cmk_id |
String |
参数解释 快照所属的云硬盘ID的密钥ID。 取值范围 不涉及。 |
|
category |
String |
参数解释 快照类型。 取值范围 枚举值：standard/flash。 |
|
availability_zone |
String |
参数解释 快照所属AZ。 取值范围 不涉及。 |
|
tags |
Map<String,String> |
参数解释 快照所属标签。 取值范围 不涉及。 |
|
instant_access |
Boolean |
参数解释 是否开启了快照快速可用功能。 取值范围 true：开启。仅SSD系列云盘支持开启该功能。 false：关闭。即快照为未开启快照极速可用功能的普通快照。 |
|
retention_at |
String |
参数解释 快照保留的时间。 取值范围 不涉及。 |
|
instant_access_retention_at |
String |
参数解释 设置快照快速可用功能的保留时间，保留时间到期后自动关闭快照快速可用功能。 取值范围 默认与参数retention_at的值一致。 |
|
incremental |
Boolean |
参数解释 是否增量快照。 取值范围 不涉及。 |
|
snapshot_type |
String |
参数解释 快照创建来源。 取值范围 auto：自动创建快照。 user：手动创建快照。 copy：复制快照。 |
|
progress |
String |
参数解释 快照创建进度，单位为百分比。 取值范围 不涉及。 |
|
encrypt_algorithm |
String |
参数解释 加密快照的加密算法。 取值范围 不涉及。 |
|
snapshot_chains |
Array of SnapshotChains objects |
参数解释 快照所属的快照链信息。 取值范围 不涉及。 |
|
snapshot_group_id |
String |
参数解释 快照所属的一致性快照组id。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释 快照链ID。 取值范围 不涉及。 |
|
availability_zone |
String |
参数解释 快照链所属云硬盘的可用区。 取值范围 不涉及。 |
|
snapshot_count |
Integer |
参数解释 快照链上的快照个数。 取值范围 不涉及。 |
|
capacity |
Integer |
参数解释 快照链的大小。 取值范围 不涉及。 |
|
project_id |
String |
参数解释 项目ID。 取值范围 不涉及。 |
|
volume_id |
String |
参数解释 快照链所属的云硬盘ID。 取值范围 不涉及。 |
|
category |
String |
参数解释 快照链的类型。 取值范围 不涉及。 |
|
created_at |
String |
参数解释 创建时间。 取值范围 不涉及。 |
|
updated_at |
String |
参数解释 更新时间。 取值范围 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
参数解释 出现错误时，返回的错误信息。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释 出现错误时，返回的错误码。 取值范围 错误码和其对应的含义请参考错误码说明。 |
|
message |
String |
参数解释 出现错误时，返回的错误消息。 取值范围 不涉及。 |
请求示例
GET https://{endpoint}/v5/{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,
"category": "flash"
"enterprise_project_id": "0",
"encrypted": false,
"availability_zone": "az1.dc1",
"tags": {}
},
{
"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,
"category": "flash"
"enterprise_project_id": "0",
"encrypted": false,
"availability_zone": "az1.dc1",
"tags": {}
}
]
}
状态码：400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
错误码
请参见错误码。
