ListSnapshotsDetailsV5
功能介绍
查询云硬盘快照详情列表
调用方法
请参见如何调用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值。 当租户所有的快照数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例: GET /v2/xxx/snapshots/detail?limit=50,表示查询第1~50个快照。GET /v2/xxx/snapshots/detail?offset=50&limit=50,表示查询第51~100个快照。 |
name |
否 |
String |
云硬盘快照名称。最大支持255个字符。 |
offset |
否 |
String |
说明:
分页查询快照时使用,与limit配合使用。假如共有30个快照, 设置offset为11,limit为10,即为从第12个快照开始查询, 一次最多可读取10个快照。 偏移量。 分页查询快照时使用,与limit配合使用。假如共有30个快照, 设置offset为11,limit为10,即为从第12个快照开始查询, 一次最多可读取10个快照。 |
status |
否 |
String |
云硬盘快照状态,具体请参见云硬盘快照状态。 |
sort_key |
否 |
String |
返回结果按该关键字排序,支持id,status,created_at等关键字,默认为“created_at”。 |
sort_dir |
否 |
String |
返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc |
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的值)。 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
snapshots_links |
Array of Link objects |
云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段,返回该字段表示本次查询只查出了部分云硬盘快照信息。 |
snapshots |
Array of SnapshotDetailV5 objects |
快照信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
云硬盘快照ID。 |
name |
String |
云硬盘快照名称。 名称以autobk_snapshot_为前缀的快照是创建云硬盘备份时系统自动创建的,请不要进行“删除云硬盘快照”和“回滚快照到云硬盘”操作。 云硬盘快照名称。 名称以autobk_snapshot_为前缀的快照是创建云硬盘备份时系统自动创建的,请不要进行“删除云硬盘快照”和“回滚快照到云硬盘”操作。 |
description |
String |
云硬盘快照描述信息。 |
created_at |
String |
云硬盘快照创建时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX 云硬盘快照创建时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
updated_at |
String |
云硬盘快照更新时间 |
volume_id |
String |
快照所属的云硬盘ID。 |
size |
String |
云硬盘快照大小,单位为GiB。 |
status |
String |
云硬盘快照的状态,具体请参见云硬盘快照状态。 |
project_id |
String |
租户ID。租户ID就是项目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:手动创建快照。 |
progress |
String |
快照创建进度,单位为百分比。 |
encrypt_algorithm |
String |
加密快照的加密算法 |
snapshot_chains |
Array of SnapshotChains objects |
快照所属的快照链信息 |
snapshot_group_id |
String |
快照所属的一致性快照组id |
preheats |
Array of SnapshotPreheatDetail objects |
快照的预热信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
更新时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
预热的状态。 |
source_type |
String |
预热的数据源类型。 |
source_id |
String |
预热的数据源ID。 |
availability_zone |
String |
预热的AZ信息。 |
volume_type |
String |
预热的云硬盘类型。 |
count |
String |
预热的总个数。 |
available_count |
String |
当前可用的预热个数。 |
progress |
String |
预热的进度。 |
created_at |
String |
预热的创建时间。 |
updated_at |
String |
预热的更新时间。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
出现错误时,返回的错误信息。 |
请求示例
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": {} } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
{ "error": { "message": "XXXX", "code": "XXX" } } |
错误码
请参见错误码。