删除快照

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

我的收藏

1. 接口描述

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

本接口(DeleteSnapshots)用于删除快照。

  • 快照必须处于NORMAL状态,快照状态可以通过DescribeSnapshots接口查询,见输出参数中SnapshotState字段解释。
  • 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteSnapshots。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SnapshotIds.N Array of String 要删除的快照ID列表,可通过DescribeSnapshots查询。
示例值:["snap-gybrif0z\n"]
DeleteBindImages Boolean 是否强制删除快照关联的镜像
示例值:true

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除快照

删除指定快照

输入示例

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

{
    "SnapshotIds": [
        "snap-cgrmci8t"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "b4770576-d9eb-4689-0866-5a1f8200a722"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidSnapshot.NotSupported 快照不支持该操作。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
MissingParameter 缺少参数错误。
ResourceBusy 资源繁忙,请稍后重试。
ResourceUnavailable.SnapshotCreating 快照尚未创建完成,暂时不可使用。
UnauthorizedOperation.MFAExpired MFA鉴权过期,请重试。
UnsupportedOperation 操作不支持。
UnsupportedOperation.SnapHasShared 该快照已经共享,请先解除共享。
UnsupportedOperation.SnapshotHasBindedImage 该快照创建了自定义快照,请先删除对应镜像。