ShowSnapshotV5
功能介绍
查询单个云硬盘快照信息。
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/snapshots/{snapshot_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参见"获取项目ID"。 项目ID。 获取方法请参见"获取项目ID"。 |
snapshot_id |
是 |
String |
快照ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
snapshot |
SnapshotDetailV5 object |
参数 |
参数类型 |
描述 |
---|---|---|
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/{snapshot_id}
响应示例
状态码: 200
OK
{ "snapshot" : { "id" : "308c213b-5e09-478e-a772-c81b20749fea", "status" : "available", "project_id" : "7c08fb7726964bf5b70a1f55a4cd6017", "size" : 1, "name" : null, "description" : null, "cmk_id" : null, "encrypted" : false, "created_at" : "2023-07-03T08:53:13.373010", "updated_at" : "2023-07-03T08:53:13.578010", "volume_id" : "66016b8d-b850-4afb-b2a4-d5903e9ffb59", "enterprise_project_id" : "0", "category" : "flash", "availability_zone" : "az2.dc2", "tags" : { }, "instant_access" : true, "instant_access_retention_at" : "2023-07-07T08:53:13.373010", "retention_at" : "2023-07-07T08:53:13.373010" } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
{ "error": { "message": "XXXX", "code": "XXX" } } |
错误码
请参见错误码。