文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 备份管理/ 批量删除手动备份 - BatchDeleteBackup
更新时间：2025-11-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量删除手动备份 - BatchDeleteBackup

功能介绍

批量删除手动备份。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:backup:delete

    Write

    -

    -
    • gaussdb:backup:delete

    -

URI

DELETE /v3/{project_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

backup_ids

是

Array of strings

参数解释：

需要删除的手动备份ID列表。

通过调用备份管理查询全量备份列表接口获取。

约束限制：

列表数量小于等于50。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

failed_results

Array of DeleteBackupResult objects

参数解释：

备份删除异常信息。

取值范围：

当所有备份删除成功，该值是空。

success_count

Integer

参数解释：

删除成功的数量。

取值范围：

0-50。

failed_count

Integer

参数解释：

删除失败的数量。

取值范围：

0-50。
表5 DeleteBackupResult

参数

参数类型

描述

backup_id

String

参数解释：

备份ID。

取值范围：

不涉及。

error_code

String

参数解释：

提交任务异常时返回的编码。

取值范围：

不涉及。

error_msg

String

参数解释：

提交任务异常时返回的描述信息。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

批量删除手动备份。

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups

{
  "backup_ids" : [ "53ad33abe43976054br07", "63ad3439af9776054br07" ]
}

响应示例

状态码：200

Success.

{
  "failed_results" : [ {
    "backup_id" : "53ad33abe43976054br07",
    "error_code" : "DBS.201204",
    "error_msg" : "The backup type is not allowed."
  }, {
    "backup_id" : "63ad3439af9776054br07",
    "error_code" : "DBS.201203",
    "error_msg" : "The backup file does not exist."
  } ],
  "success_count" : 1,
  "failed_count" : 2
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档