更新时间:2024-04-16 GMT+08:00

创建快照(废弃)

功能介绍

创建卷快照。

当前API已废弃,请使用对应的存储服务接口“创建云硬盘快照(OpenStack原生 v2)”。

接口约束

用户创建的快照名称不能使用autobk_snapshot为前缀。

URI

POST /v2.1/{project_id}/os-snapshots

参数说明请参见表1
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

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

请求消息

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

display_description

String

快照的描述。

volume_id

String

卷ID。

display_name

String

云硬盘快照名称。

最大支持255个字节。

说明:

通过VBS对云硬盘创建备份时,同时会创建以autobk_snapshot_为名称前缀的快照,云硬盘控制台对此类快照会有操作限制。因此,建议您不要创建以autobk_snapshot_为名称前缀的快照,避免影响快照的正常使用。

force

Boolean

是否执行强制创建。force为true时,支持卷在in-use状态时创建快照。

响应消息

响应参数如表3所示。

表3 响应参数

参数

是否必选

参数类型

描述

id

String

卷快照ID,UUID格式

status

String

卷快照的状态

displayName

String

卷快照名称

displayDescription

String

卷快照描述信息

createdAt

String

卷快照创建时间

volumeId

String

快照所属的卷ID,UUID格式

size

Integer

卷快照大小

请求示例

POST https://{endpoint}/v2.1/d6c277ba8820452e83df36f33c9fa561/os-snapshots
{
	"snapshot": {
		"display_name": "test",
		"display_description": null,
		"volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209"
	}
}

响应示例

{
    "snapshot": 
        {
            "createdAt": "2016-05-20T16:54:14.981520", 
            "displayDescription": null, 
            "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",  
            "displayName": "test", 
            "size": 1, 
            "status": "creating", 
            "volumeId": "ba5730ea-8621-4ae8-b702-ff0ffc12c209"
        }
}

返回值

请参考通用请求返回值