---
title: "设置集群级配置 - OceanBase 数据库 V4.3.0 | OceanBase 文档中心"
description: 设置集群级配置 通过调用 API 接口可设置集群级配置，包括集群 ID（ clusterId ）、集群名（ clusterName ）、Root Service 列表（ rsList ）和 root@sys 用户密码（ rootPwd ）。 说明 设置集群级配置时采取全量覆盖策略，即原有配置将被新配置完全替代。 调用…
---
切换语言

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

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

# 设置集群级配置

更新时间：2026-04-10 11:58:35

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.3.0/zh-CN/700.reference/1500.Components-and-Tools/100.manage/100.obshell/400.obshell-api-reference/410.set-cluster-level.md)  

通过调用 API 接口可设置集群级配置，包括集群 ID（`clusterId`）、集群名（`clusterName`）、Root Service 列表（`rsList`）和 root@sys 用户密码（`rootPwd`）。

#### 说明

设置集群级配置时采取全量覆盖策略，即原有配置将被新配置完全替代。

## 调用说明

### 接口约束

obshell Server 会对该 API 进行安全校验，详细介绍可参见 [API 混合加密](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000694620)。

### 请求路径

POST /api/v1/obcluster/config

PUT /api/v1/obcluster/config

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| clusterId | string | 否 | 1 | 设置集群 ID。 |
| clusterName | string | 否 | ob-test | 设置集群名。 |
| rootPwd | string | 否 | 无 | 设置集群密码（需要将密码加密），详细介绍可参见 [API 混合加密](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000694620)。 |

### 返回结果

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 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-1000000000694622)。 |

## 示例

### 请求示例

```json
"{
  "clusterId":1,
   "clusterName":"upgrade",
   "rootPwd":"SlCfrxyY+iJom1G8Ad74PZ2Rz46W9fY4ffxr+Lt0uKJQnyamfwVvMo9cJ0CqoccZS0p4FH+U3vJXH4C62O3/SLttVGRLblJzPKRyKYdZU59fjhBwyjrsLc5ZwsWsJpsN5kuFyb3gCEO5vVmQKxqJmwQjAdpYWuPAU0xzBA8QM6o="
}"

```

### 返回示例

```json
{
  "successful": true,
  "timestamp": "2024-01-09T15:14:26.299401393+08:00",
  "duration": 1,
  "status": 200,
  "traceId": "6328313e8d9fd63b",
  "data": {
    "id": "22130706433028869",
    "dag_id": 2,
    "name": "Update cluster config",
    "stage": 1,
    "max_stage": 1,
    "state": "READY",
    "operator": "RUN",
    "start_time": "2024-01-09T15:14:26.29828992+08:00",
    "end_time": "2024-01-09T15:14:26.29828992+08:00",
    "additional_data": null,
    "nodes": null
  }
}

```

## 相关文档

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

- 通过 obshell-sdk-python 请求 API 方法的介绍可参见 [设置集群级配置](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000904131)。
 - 通过 obshell-sdk-go 请求 API 方法的介绍可参见 [设置集群级配置](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000904158)。

 上一篇 下一篇 ![有帮助](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) 咨询热线