DeleteSnapshots

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名: cbs.api3.gsesgpucloud.com。

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

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

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

接口更新时间:2024-07-15 22:26:11。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DeleteSnapshots
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
SnapshotIds Array of String 要删除的快照ID列表,可通过 DescribeSnapshots查询。
示例值:
DeleteBindImages Bool 是否同时删除快照关联的镜像;取值为false,表示不删除快照绑定的镜像,此时,如果快照有绑定的镜像,删除会失败;取值为true,表示同时删除快照绑定的镜像;默认值为false
示例值:

3. 输出参数

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

4. 错误码

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

错误码 描述
MissingParameter 参数缺失。请求没有带必选参数。
UnsupportedOperation.SnapshotHasBindedImage 快照已绑定镜像
InvalidSnapshot.NotSupported 快照不支持该操作。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。