创建快照

最近更新时间:2024-03-12 01:12:37

我的收藏

1. 接口描述

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

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

  • 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由DescribeDisks接口查询,见SnapshotAbility字段。
  • 可创建快照数量限制见产品使用限制
  • 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSnapshot。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DiskId String 需要创建快照的云硬盘ID,可通过DescribeDisks接口查询。
示例值:disk-l7mxexxc
SnapshotName String 快照名称,不传则新快照名称默认为“未命名”。
示例值:test
Deadline Timestamp ISO8601 快照的到期时间,到期后该快照将会自动删除,需要传入UTC时间下的ISO-8601标准时间格式,例如:2022-01-08T09:47:55+00:00,。到期时间最小可设置为一天后的当前时间。
示例值:2022-01-08T09:47:55+00:00
DiskBackupId String 云硬盘备份点ID。传入此参数时,将通过备份点创建快照。
示例值:dbp-xxxxxxxx
Tags.N Array of Tag 快照绑定的标签。

3. 输出参数

参数名称 类型 描述
SnapshotId String 新创建的快照ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:snap-3xvkxyxp
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建快照

用户创建快照

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSnapshot
<公共请求参数>

{
    "SnapshotName": "snap_201711301015",
    "Deadline": "2022-01-08T09:47:55+00:00",
    "DiskId": "disk-lzrg2pwi"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InsufficientSnapshotQuota 快照配额不足。
InternalError.ComponentError 依赖组件请求失败,请联系客服人员解决。
InternalError.ResourceOpFailed 对资源的操作失败,具体错误信息请查看错误描述 Message 字段,稍后重试或者联系客服人员帮忙解决。
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidDisk.Busy 云硬盘忙,请稍后重试。
InvalidDisk.NotSupportSnapshot 云硬盘没有快照能力。
InvalidDisk.NotSupported 云硬盘不支持该操作。
InvalidDisk.SnapshotCreating 云硬盘正在创建快照,请稍后重试。
InvalidDisk.TypeError 云硬盘类型错误。
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameter.ProjectIdNotExist 项目ID不存在。
LimitExceeded.InstanceAttachedDisk 实例挂载云盘数量超过限制。
MissingParameter 缺少参数错误。
ResourceBusy 资源繁忙,请稍后重试。
ResourceInUse 资源被占用。
ResourceInUse.DiskMigrating 云硬盘当前已在迁移中,请稍后重试。
ResourceInUse.DiskRollbacking 云硬盘正在执行快照回滚操作,请稍后重试。
ResourceInsufficient.OverQuota 配额不足。
ResourceNotFound.NotFound 资源不存在。
ResourceUnavailable.DiskSnapshotChainTooLarge 云硬盘快照链长度过长,拒绝创建快照。
ResourceUnavailable.NotSupported 资源不支持此操作。
ResourceUnavailable.SnapshotCreating 快照尚未创建完成,暂时不可使用。
ResourceUnavailable.TooManyCreatingSnapshot 全网正在创建的快照数量过多。
UnsupportedOperation.DiskEncrypt 磁盘已加密。