查看单个租户备份任务

查看单个租户备份任务

更新时间：2025-09-14 08:24:45

编辑

本文介绍如何通过 API 查看单个租户备份任务。

调用说明

接口约束

如果设置了密码，则需要通过认证。详情可参见 API 混合加密。

请求路径

GET /api/v1/tenant/:name/backup/overview

返回结果

参数	类型	说明
successful	bool	请求是否成功。
timestamp	time.Time	服务端完成请求的时间戳。
duration	int	服务端处理请求的时间（毫秒）。
status	int	符合 HTTP Status 规范的编码。
traceId	string	请求的 Trace ID。
data	CdbObBackupTask	备份任务列表。
error	ApiError	请求产生的 Error，包含如下信息： `code`：错误码。 `message`：错误详细信息。 `subErrors`：子错误信息。

CdbObBackupTask 的数据结构：

参数	类型	说明
tenant_id	int	租户 ID。
task_id	int	Task 级备份任务 ID，对应一个备份集的任务。
job_id	int	该 Task 任务所属的 JOB_ID。
incarnation	int	表示 Flashback Database 后的第几次分身。
backup_set_id	int	该 Task 对应的备份集 ID。
start_timestamp	time.Time	Task 任务的开始时间。
end_timestamp	time.Time	Task 任务的结束时间。
status	string	备份的状态。
start_scn	int	备份开始的 SCN。
end_scn	int	备份结束的 SCN。
user_ls_start_scn	int	备份日志流 META 的 SCN。
encryption_mode	string	加密模式，有如下取值： `None`：表示不加密。 `Password`：表示只使用密码保护。 `Password Encryption`：表示加密，并且使用密码保护。 `Transparent Encryption`：表示使用 TDE 加密。 `Dual mode Encryption`：表示使用 TDE 加密以及密码保护。目前仅支持 `None` 和 `Password` 两种模式。
input_bytes	int	输入字节数。
output_bytes	int	输出字节数。
output_rate_bytes	int	每秒输出字节数。
extra_meta_bytes	int	额外字节数。
tablet_count	int	TABLET 总量。
finish_tablet_count	int	完成备份的 TABLET 总量。
macro_block_count	int	宏块数。
finish_macro_block_count	int	完成备份的宏块数。
file_count	int	备份文件数。
meta_turn_id	int	备份 META 的轮次。
data_turn_id	int	备份 DATA 的轮次。
result	int	备份错误码结果。
comment	string	错误码描述。
path	string	备份路径。

示例

请求示例

GET 10.10.10.1:2886/api/v1/tenant/tenant1/backup/overview

返回示例

{
  "successful": true,
  "timestamp": "2024-10-12T18:16:17.54002369+08:00",
  "duration": 36,
  "status": 200,
  "traceId": "11ae266d93f6e7c7",
  "data": {
    "status": {
      "tenant_id": 1002,
      "task_id": 1,
      "job_id": 1,
      "incarnation": 1,
      "backup_set_id": 1,
      "start_timestamp": "2024-10-12T18:08:08.723714+08:00",
      "end_timestamp": "2024-10-12T18:10:43.487426+08:00",
      "status": "COMPLETED",
      "start_scn": 1728727696264250400,
      "end_scn": 1728727843446713000,
      "user_ls_start_scn": 1728727710694531300,
      "encryption_mode": "NONE",
      "input_bytes": 128825794,
      "output_bytes": 22320897,
      "output_rate_bytes": 144225.6503,
      "extra_meta_bytes": 0,
      "tablet_count": 596,
      "finish_tablet_count": 596,
      "macro_block_count": 61,
      "finish_macro_block_count": 61,
      "file_count": 0,
      "meta_turn_id": 1,
      "data_turn_id": 0,
      "result": 0,
      "comment": "",
      "path": "oss://oss-328067-1012-obshell/backup/archive/test/1/1002/data?host=oss-cn-hangzhou.aliyuncs.com"
    }
  }
}