1. 接口描述
接口请求域名: cbs.tencentcloudapi.com 。
本接口(ApplySnapshot)用于回滚快照到原云硬盘。
- 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用CreateDisks接口创建新的弹性云盘,将快照数据复制到新购云盘上。
- 用于回滚的快照必须处于NORMAL状态。快照状态可以通过DescribeSnapshots接口查询,见输出参数中SnapshotState字段解释。
- 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过DescribeDisks接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过DescribeInstancesStatus接口查询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ApplySnapshot。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SnapshotId | 是 | String | 快照ID, 可通过DescribeSnapshots查询。 示例值:snap-3xvkxxmp |
DiskId | 是 | String | 快照原云硬盘ID,可通过DescribeDisks接口查询。 示例值:disk-ouxaxxt2 |
AutoStopInstance | 否 | Boolean | 回滚前是否执行自动关机 示例值:False |
AutoStartInstance | 否 | Boolean | 回滚完成后是否自动开机 示例值:False |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 回滚快照
回滚云盘某个快照节点
输入示例
https://cbs.tencentcloudapi.com/?Action=ApplySnapshot
&DiskId=disk-lzrg2pwi
&SnapshotId=snap-gybrif0z
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "cc96242e-566c-ae6a-b74a-5a1f823683b2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidDisk.Busy | 云硬盘忙,请稍后重试。 |
InvalidDisk.NotSupported | 云硬盘不支持该操作。 |
InvalidDisk.SnapshotCreating | 云硬盘正在创建快照,请稍后重试。 |
InvalidDiskId.NotFound | 输入的DiskId 不存在。 |
InvalidInstance.NotSupported | 云服务器不支持挂载云盘。 |
InvalidInstanceId.NotFound | 输入实例的InstanceId 不存在。 |
InvalidParameter.DiskSizeNotMatch | 云硬盘大小与快照大小不匹配。 |
InvalidParameter.ShouldConvertSnapshotToImage | 需要将快照转化成镜像后再执行操作。 |
InvalidParameterValue | 参数取值错误。 |
InvalidSnapshot.NotSupported | 快照不支持该操作。 |
InvalidSnapshotId.NotFound | 输入的SnapshotId 不存在。 |
MissingParameter | 缺少参数错误。 |
ResourceBusy | 资源繁忙,请稍后重试。 |
ResourceInUse.DiskRollbacking | 云硬盘正在执行快照回滚操作,请稍后重试。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.NotFound | 资源不存在。 |
ResourceUnavailable.NotSupported | 资源不支持此操作。 |
ResourceUnavailable.SnapshotCreating | 快照尚未创建完成,暂时不可使用。 |
UnauthorizedOperation.MFAExpired | MFA鉴权过期,请重试。 |