---
title: "发起集群级备份 - OceanBase 数据库 V4.3.5 | OceanBase 文档中心"
description: 发起集群级备份 本文介绍如何通过 API 发起集群级备份。 调用说明 接口约束 如果设置了密码，则需要通过认证。详情可参见 API 混合加密 。 请求路径 POST /api/v1/obcluster/backup 请求参数 参数 类型 必选 示例值 描述 mode string 否 "full" 数据备份模式，可取…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.3.5 LTS

# 发起集群级备份

更新时间：2026-04-07 20:57:20

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.3.5/zh-CN/700.reference/1500.Components-and-Tools/100.manage/100.obshell/400.obshell-api-reference/600.backup-management/600.initiate-cluster-level-tenant-backup.md)  

本文介绍如何通过 API 发起集群级备份。

## 调用说明

### 接口约束

如果设置了密码，则需要通过认证。详情可参见 [API 混合加密](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002016169)。

### 请求路径

POST /api/v1/obcluster/backup

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| mode | string | 否 | "full" | 数据备份模式，可取值为 `full` 和 `incremental`，分别表示全量备份（`full`）和增量备份（`incremental`）。 |
| plus_archive | bool | 否 | true | 添加 plus_archive 后，可以在数据备份过程中同时将归档日志一起备份，最终备份目录下会生成一份带有归档日志的完整数据集。该数据集具备恢复能力，可以不依赖归档日志，使用该数据集将租户的数据恢复到 min_restore_scn 位点。 |
| encryption | string | 否 | "pwd" | 备份后的备份集的密码。 |

### 返回结果

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

DagDetailDTO 信息的数据结构如下：

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | string | DAG 通用 ID。 |
| dag_id | int | DAG id，是记录在 OceanBase 数据库中的主键。 |
| name | string | DAG 名称。 |
| stage | int | DAG 的当前执行阶段。 |
| max_stage | int | DAG 执行过程中的总阶段数。 |
| state | string | DAG 执行状态。 |
| operator | string | DAG 执行操作类型。 |
| start_time | time.Time | DAG 执行起始时间。 |
| end_time | time.Time | DAG 执行结束时间。 |
| additional_data | map[string]any | DAG 其他数据。 |
| nodes | []NodeDetailDTO | DAG 内的所有 Node 信息，详见 [获取 Node 的详细信息](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002017152)。 |

## 示例

### 请求示例

POST 10.10.10.1:2886/api/v1/obcluster/backup

```json
{
  "mode":"full",
}

```

### 返回示例

```json
{
  "successful": true,
  "timestamp": "2024-01-09T17:11:43.385889278+08:00",
  "duration": 1,
  "status": 200,
  "traceId": "877fe32b83634153",
  "data": {
    "id": "22130706433028869",
    "dag_id": 4,
    "name": "Obcluster start full backup",
    "stage": 1,
    "max_stage": 2,
    "state": "READY",
    "operator": "RUN",
    "start_time": "2024-01-09T17:11:43.384630643+08:00",
    "end_time": "2024-01-09T17:11:43.384630643+08:00",
    "additional_data": null,
    "nodes": null
  }
}

```

## 相关文档

除通过命令行调用 API 接口外，还可以通过 SDK 方法调用 API。

- 通过 obshell-sdk-python 请求 API 方法的介绍可参见 [发起集群级备份](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002017802)。
 - 通过 obshell-sdk-go 请求 API 方法的介绍可参见 [发起集群级备份](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000002017863)。

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线