1. 接口描述
本接口(ApplySnapshot)用于回滚快照到原云硬盘,暂不支持回滚到其它云硬盘。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用 CreateCbsStorages(创建弹性云盘),创建新的弹性云盘。
接口请求域名:snapshot.api.qcloud.com
使用限制:
- 快照必须处于
normal
状态。快照状态可以通过 DescribeSnapshots(查询快照列表) 接口查询,见输出参数中status
字段解释。 - 只支持回滚快照到原云硬盘上。
- 如果是弹性云盘,则弹性云盘必须处于未挂载状态,云硬盘挂载状态可以通过 DescribeCbsStorages(查询云硬盘信息) 接口查询,见输出参数中
attached
字段;如果是随云服务器一块购买的非弹性云盘,则云服务器必须处于关机状态,云服务器状态可以通过 查看实例列表 接口查询,见输出参数中status
字段。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
snapshotId | 是 | String | 快照 ID,可通过 DescribeSnapshots(查询快照列表) 接口查询 |
storageId | 是 | String | 快照原云硬盘 ID,可通过 DescribeSnapshots(查询快照列表) 接口查询 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码。0:成功,其他值:失败 |
message | String | 错误信息 |
detail | Array | 返回的数组 |
detail.requestId | Int | 任务 ID,参见 异步任务接口返回格式 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 云硬盘错误码。
错误代码 | 英文描述 | 错误描述 |
---|---|---|
9003 | InvalidParameter | 参数错误 |
16005 | IncorrectInstanceStatus.DiskBusy | 云盘繁忙 |
16027 | IncorrectInstanceStatus.CbsCreatingSnapshot | 云硬盘正在创建快照中,请稍后重试 |
5. 示例
输入:
https://snapshot.api.qcloud.com/v2/index.php? <公共请求参数> &Action=ApplySnapshot &snapshotId=snap-pxxx2xmn &storageId=disk-g7xxxs4o
输入:
{
"code":"0",
"message":""
}