文档首页/数据库安全服务 DBSS/API参考/API说明/备份管理/获取所有备份信息 - ListAuditBackupInfo
更新时间：2026-01-22 GMT+08:00
查看PDF
分享

获取所有备份信息 - ListAuditBackupInfo

功能介绍

获取所有备份信息

URI

POST /v2/{project_id}/audit/{instance_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

end_time

否

String

结束时间

page

是

Integer

当前页码

size

是

Integer

分页大小

start_time

否

String

开始时间,yyyy-MM-dd HH:mm:ss

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of BackupInfo objects

备份列表

total_num

Long

总记录数

表5 BackupInfo

参数

参数类型

描述

backup_task_fail_reason

String

备份失败原因

backup_time

String

备份时间，yyyy-MM-dd HH:mm:ss

deleted

Boolean

标记删除

end_time

String

备份结束时间，yyyy-MM-dd HH:mm:ss

file_size

Long

文件大小

file_size_unit

String

文件大小单位

  • Byte：Byte

  • KB：kb

  • MB：mb

  • GB：gb

id

String

备份ID

mode

String

备份方式

  • AUTO：自动备份

name

String

备份名称

percentage

Integer

备份进度

progress

String

进度

  • CLEAN_AFTER_FAILED：清理失败

  • DELETING：删除中

  • DELETED：已删除

  • DELETE_FAIL：删除失败

  • RESTORING_WAITING：恢复等待中

  • RESTORING：恢复中

  • RESTORED：已恢复

  • RESTORE_FAIL：恢复失败

  • BACKUP_WAITING：等待备份

  • FILE_UPLOAD_WAITING：等待上传备份文件

  • FILE_UPLOADING：上传中

  • AUTO_BACKUPING：自动备份中

  • AUTO_BACKUPED：自动备份结束

  • AUTO_BACKUP_FAIL：自动备份失败

  • MANUAL_BACKUPING：手动备份中

  • MANUAL_BACKUPED：手动备份结束

  • MANUAL_BACKUP_FAIL：手动备份失败

  • ISAP_WAITING：ISAP等待备份

  • ISAP_BACKUPING：ISAP备份中

  • ISAP_BACKUPED：ISAP备份成功

  • ISAP_BACKUP_FAIL：ISAP备份失败

  • ISAP_FILE_UPLOAD_WAITING：ISAP等待上传备份文件

  • ISAP_FILE_UPLOADING：ISAP上传中

restore_task_fail_reason

String

还原失败原因

sha256

String

文件SHA256

start_time

String

备份开始时间,yyyy-MM-dd HH:mm:ss

状态码：400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表12 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表13 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v2/{project_id}/audit/{instance_id}/backups

{
  "page" : 1,
  "size" : 10
}

响应示例

状态码：200

OK

{
  "total_num" : 1,
  "data_list" : [ {
    "id" : "XwRQyJgBhN3UjKKc3yhJ",
    "name" : "auto_backup_20250820-00_00~23_59",
    "backup_time" : "2025-08-20 16:30:00",
    "file_size" : 20,
    "file_size_unit" : "Byte",
    "mode" : "AUTO",
    "start_time" : "2025-08-19 16:00:00",
    "end_time" : "2025-08-20 15:59:59",
    "percentage" : 0,
    "deleted" : false,
    "progress" : "RESTORED",
    "backup_task_fail_reason" : null,
    "restore_task_fail_reason" : null,
    "sha256" : "59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2"
  } ]
}

状态码

状态码

描述

200

OK

400

请求参数有误

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题：备份管理