删除快照组

最近更新时间:2025-02-21 01:12:52

我的收藏

1. 接口描述

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

本接口(DeleteSnapshotGroup)用于删除快照组,一次调用仅支持删除一个快照组。

  • 默认会删除快照组内的所有快照;
  • 如果快照组内的快照有关联镜像,则删除失败,所有快照均不会删除;如果需要同时删除快照绑定的镜像,可传入参数DeleteBindImages等于true。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteSnapshotGroup。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SnapshotGroupId String 快照组ID。
示例值:csnap-gv9naz67
SnapshotGroupIds.N Array of String 快照组ID 列表。此参数与快照组 ID 至少传 1 个,同时传会与快照组 ID 合并。
示例值:["csnap-gv9naz66"]
DeleteBindImages Boolean 是否同时删除快照组关联的镜像;取值为false,表示不删除快照组绑定的镜像,此时,如果快照组有绑定的镜像,删除会失败;取值为true,表示同时删除快照组绑定的镜像;默认值为false。
示例值:true

3. 输出参数

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

4. 示例

示例1 删除快照组

删除快照组,并同时删除快照组绑定的镜像。

输入示例

https://cbs.tencentcloudapi.com/?Action=DeleteSnapshotGroup
&SnapshotGroupId=csnap-gv9naz6b
&DeleteBindImages=true
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "d7c2dd0f-59b1-4243-af5f-8443a1527daa"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
MissingParameter 缺少参数错误。
UnsupportedOperation.SnapshotHasBindedImage 该快照创建了自定义快照,请先删除对应镜像。
UnsupportedOperation.StateError 资源当前状态不支持该操作。