云硬盘快照
创建云硬盘快照
功能介绍
创建一个云硬盘快照。
创建云盘快照,它是一个时间点,完整的云盘副本。
前提条件
用户必须有足够的快照配额来创建一个快照。
URI
示例：POST /v2/{project_id}/snapshots
说明：需使用“行内代码”样式。
| 参数 | 是否必选 | 描述 |
|---|---|---|
| project_id | 是 | 项目ID。 |
请求消息
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| volume_id | String | 是 | 云硬盘的id。 |
| description | String | 否 | 快照的描述，或为空。 |
| force | integer | 否 | 指示是否强制创建快照,即使云盘正在使用。默认值为false。 |
| name | String | 否 | 快照的名称。 |
请求示例
示例一:对云硬盘创建一个快照
{
"snapshot": {
"name": "test-snap-001",
"force": false,
"volume_id": "48143d66-e467-483c-ade1-f1b41bbb067b",
"description": "create volume-snapshots"
}
}
响应消息
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 快照的状态。 |
| description | String | 快照的描述信息或为空。 |
| created_at | String | 创建快照的日期和时间。 |
| name | String | 快照的名称 |
| volume_id | String | 快照对应云盘的id。 |
| metadata | object | 快照的一个或多个元数据键和值对 |
| id | String | 快照的id。 |
| size | integer | 快照的大小。单位为:GB |
正常响应示例
{
"snapshot": {
"id": "0412012d-bb44-49d2-9a57-4d3e971938db",
"created_at": "2022-03-24T07:46:22.542932",
"updated_at": null,
"name": "test-snap-001",
"description": "create volume-snapshots",
"volume_id": "48143d66-e467-483c-ade1-f1b41bbb067b",
"status": "creating",
"size": 10,
"metadata": {}
}
}查询云硬盘快照列表
功能介绍
列出项目可以访问的所有云硬盘快照的详细信息。
URI
示例：GET /v2/{project_id}/snapshots
说明：需使用“行内代码”样式。
| 参数 | 是否必选 | 描述 |
|---|---|---|
| project_id | 是 | 项目ID。 |
请求消息
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| limit | integer | 否 | 查询的最大个数限制 |
| marker | String | 否 | 最后一项的ID。 |
| sort_key | String | 否 | 按照云硬盘快照属性排序。 |
| sort_dir | String | 否 | 排序方向。 |
请求示例
示例一:列举本项目下所有的云盘快照
GET /v2/{project_id}/snapshots示例二:列举所有项目下的云盘快照的详细信息(仅限云管理员)
GET /v2/{project_id}/snapshots/detail?all_tenants=1响应消息
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 云盘快照的id。 |
| status | String | 云盘的状态。 |
| description | integer | 云盘快照的描述信息。 |
| created_at | String | 云盘快照的创建时间。 |
| name | String | 云盘快照的名称。 |
| volume_id | String | 云盘的id。 |
| metadata | String | 快照的一个或多个元数据键和值对(如果有)。 |
| size | String | 云盘快照的大小。 |
| updated_at | String | 云盘快照的更新时间。 |
响应示例
{
"snapshots": [
{
"id": "c73392ad-2195-4501-848f-b955a05c8a11",
"created_at": "2022-03-24T06:08:36.000000",
"updated_at": "2022-03-24T06:08:40.000000",
"name": "test-snapshot",
"description": "",
"volume_id": "e13face6-05b6-4e62-8f0e-4a6fa3026645",
"status": "available",
"size": 10,
"metadata": {}
},
{
"id": "7ad994f2-340f-46a1-8f5a-ce7f0c22e733",
"created_at": "2022-03-24T06:08:12.000000",
"updated_at": "2022-03-24T06:08:15.000000",
"name": "1",
"description": "",
"volume_id": "e13face6-05b6-4e62-8f0e-4a6fa3026645",
"status": "available",
"size": 10,
"metadata": {}
}
]
}
显示云硬盘快照的详细信息
功能介绍
显示一个快照的详细信息。
URI
示例：GET /v2/{project_id}/snapshots/{snapshot_id}
说明：需使用“行内代码”样式。
| 参数 | 是否必选 | 描述 |
|---|---|---|
| project_id | 是 | 项目ID。 |
| snapshot_id | 是 | 云盘快照的id。 |
响应消息
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 云盘快照的id。 |
| status | String | 云盘的状态。 |
| description | integer | 云盘快照的描述信息。 |
| created_at | String | 云盘快照的创建时间。 |
| name | String | 云盘快照的名称。 |
| volume_id | String | 云盘的id。 |
| metadata | String | 快照的一个或多个元数据键和值对(如果有)。 |
| os-extended-snapshot-attributes:project_id | String | 云盘快照所属项目的UUID。 |
| os-extended-snapshot-attributes:progress | String | 云盘快照创建进度的百分比值。 |
响应示例
{
"snapshot": {
"id": "c73392ad-2195-4501-848f-b955a05c8a11",
"created_at": "2022-03-24T06:08:36.000000",
"updated_at": "2022-03-24T06:08:40.000000",
"name": "test-snapshot",
"description": "",
"volume_id": "e13face6-05b6-4e62-8f0e-4a6fa3026645",
"status": "available",
"size": 10,
"metadata": {},
"os-extended-snapshot-attributes:project_id": "fcdf65835e7048aba9d3e2ce4170f1d2",
"os-extended-snapshot-attributes:progress": "100%"
}
}
删除云硬盘快照
功能介绍
删除一个云硬盘快照。
URI
示例：DELETE /v2/{project_id}/snapshots/{snapshot_id}
说明：需使用“行内代码”样式。
| 参数 | 是否必选 | 描述 |
|---|---|---|
| project_id | 是 | 项目ID。 |
| snapshot_id | 是 | 云硬盘快照的id。 |
正常响应代码
200
错误码
400，401
