创建快照

最近更新时间:2018-07-27 21:02:21

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com

本接口(CreateSnapshot)用于对指定云盘创建快照。

  • 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由DescribeDisks接口查询,见SnapshotAbility字段。
  • 可创建快照数量限制见产品使用限制

接口请求频率限制:20次/每秒

注意:本接口支持金融区地域。公共参数 Region 为金融区地域时,需要同时指定带金融区地域的域名,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSnapshot
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DiskId String 需要创建快照的云硬盘ID,可通过DescribeDisks接口查询。
SnapshotName String 快照名称,不传则新快照名称默认为“未命名”。

3. 输出参数

参数名称 类型 描述
SnapshotId String 新创建的快照ID。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InsufficientSnapshotQuota 快照配额不足。
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidDisk.NotSupportSnapshot 云硬盘没有快照能力。
InvalidDisk.NotSupported 云硬盘不支持该操作。
InvalidDisk.SnapshotCreating 云硬盘正在创建快照,请稍后重试。
InvalidDisk.TypeError 云硬盘类型错误。
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter 参数缺失。请求没有带必选参数。

5. 示例

示例1 创建快照

输入示例

https://cbs.tencentcloudapi.com/?Action=CreateSnapshot
&DiskId=disk-lzrg2pwi
&SnapshotName=snap_201711301015
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "1bd35eca-0c9a-6e0b-938a-5a1f80511c19",
    "SnapshotId": "snap-gybrif0z"
  }
}

6. 其他资源

云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。