创建快照

最近更新时间:2017-12-13 11:10:04

1. 接口描述

本接口(CreateSnapshot)用于对指定云硬盘创建快照,此接口会返回新创建快照的ID,用户可使用此ID调用DescribeSnapshots(查询快照列表)接口来查询快照创建进度(percent)。快照说明详见快照作用

接口请求域名:snapshot.api.qcloud.com

使用限制:

  1. 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由DescribeCbsStorages(查询云硬盘信息)接口查询,见输出参数中snapshotAbility字段。
  2. 可创建快照数量限制见产品使用限制

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

参数名称 必选 类型 描述
storageId String 需要创建快照的云硬盘ID,可通过DescribeCbsStorages(查询云硬盘信息)接口查询
snapshotName String 快照名称,如不传则新快照名称为“未命名”

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功,其他值:失败
message String 错误信息
snapshotId String 新创建的快照ID

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见云硬盘错误码

错误代码 英文描述 错误描述
9003 InvalidParameter 参数错误
16007 IncorrectInstanceStatus.DiskTypeInvalid 当前云硬盘不支持此操作
16026 IncorrectInstanceStatus.SnapshotNotSupported 该云硬盘不支持快照功能
16005 IncorrectInstanceStatus.DiskBusy 云硬盘繁忙
16006 SnapshotQuotaExceeded 超过快照限额
16027 IncorrectInstanceStatus.CbsCreatingSnapshot 云硬盘正在创建快照中,请稍后重试

5. 示例

输入:

https://snapshot.api.qcloud.com/v2/index.php?
<公共请求参数>
&Action=CreateSnapshot
&storageId=disk-g73hhs4o
&snapshotName=mySnap

返回示例如下。从中可以看出,成功创建一个快照,快照ID为snap-o7zxxxr3

{
    "code":"0",
    "message":"",
    "snapshotId":"snap-o7zxxxr3"
}

如果有其他疑问,你也可以通过提问形式与我们联系探讨