批量删除备份文件 - BatchDeleteBackup
功能介绍
批量删除备份快照文件。可按密钥ID删除该密钥所有快照,或按快照ID删除指定快照。
同时支持传入key_ids和snapshot_ids进行批量删除。OBS对象和数据库记录同步删除。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1.0/{project_id}/kms/backups/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于唯一标识用户项目。可参考获取项目ID获取,以IAM服务接口返回值为准 约束限制: 不涉及 取值范围: 字符长度32-32。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值),以IAM服务查询用户Token接口为准 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key_ids | 否 | Array of strings | 参数解释: 指定密钥ID列表,删除这些密钥的所有备份文件 约束限制: 取值范围: 不涉及 |
| snapshot_ids | 否 | Array of strings | 参数解释: 指定快照ID列表,删除指定的备份快照 约束限制: 取值范围: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| deleted_count | Integer | 参数解释: 已删除的备份文件数量 取值范围: 不涉及 |
请求示例
按密钥ID删除该密钥的所有备份文件
{
"key_ids" : [ "0d0466b0-e727-4d9f-bd9b-e0cda5bddd3d" ]
} 响应示例
状态码:200
{
"deleted_count" : 3
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
请参见错误码。