修改 OceanBase 集群参数 - 云平台 OCP V4.3.0 | OceanBase 文档中心

文档反馈

V4.3.0

文档概览
产品简介
部署 OceanBase 云平台
升级 OceanBase 云平台
快速入门
集群管理
租户管理
OBProxy 管理
主机管理
告警中心
监控大盘
性能监控
诊断调优
运维管理
备份恢复
容灾管理
日志服务
软件包管理
系统管理
SQL 调优实践
运维最佳实践
参考指南
- 告警参考
- API 参考
  - 概述
  - API 调用说明
  - AK/SK 签名生成规则
  - 任务返回结构
  - 集群信息
    - 查询集群列表
    - 创建 OceanBase 集群
    - 删除 OceanBase 集群
    - 停止 OceanBase 集群
    - 启动 OceanBase 集群
    - 重启 OceanBase 集群
    - 升级 OceanBase 集群
    - 查 OceanBase 集群的 Zone 列表
    - OceanBase 集群新建 Zone
    - OceanBase 集群删除 Zone
    - OceanBase 集群停止 Zone
    - OceanBase 集群启动 Zone
    - OceanBase 集群重启 Zone
    - 增加 OBServer 节点
    - 批量删除 OBServer 节点
    - 停止 OBServer 节点
    - 启动 OBServer 节点
    - 重启 OBServer 节点
    - 替换 OBServer 节点
    - 修改 OceanBase 集群密码
    - 获取 OceanBase 集群参数元数据
    - 获取 OceanBase 集群参数列表
    - 修改 OceanBase 集群参数
    - 查询服务器列表
    - 查询 Zone 的服务器列表
    - Switchover 预检查
    - Failover 预检查
    - Switchover 日常切换
    - Failover 容灾切换
    - 获取 OceanBase 集群统计信息
    - 获取集群内所有 OBServer 资源统计信息
    - 获取 Unit 信息列表
  - 租户信息
  - 主机模块
  - 软件包接口
  - OBProxy 管理
  - 监控
  - 告警
  - 巡检
  - 任务管理接口
  - OCP 历史事件
  - OceanBase 用户与权限管理
  - OCP Agent 管理
  - SQL 性能
  - 备份恢复
  - 健康检查
  - 性能报告
- 监控指标参考
常见问题
附录
版本发布记录

修改 OceanBase 集群参数

更新时间：2026-04-14 11:55:54

分享

功能说明

该接口用于修改目标 OceanBase 集群的参数。

调用说明

接口约束

请求路径

PUT /api/v2/ob/clusters/{id}/parameters

请求参数

path：

参数	类型	必选	示例值	描述
id	Integer	是	1	目标 OceanBase 集群的 ID。

body：

参数	类型	必选	示例值	描述
SetClusterParameterParam	Array	是	NA	详情请参见 SetClusterParameterParam 数据结构。

SetClusterParameterParam 数据结构

参数	类型	必选	描述
name	String	是	参数名。
value	String	是	参数值。

返回结果

基础数据结构

参数	类型	说明
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

PUT /api/v2/ob/clusters/1/parameters

body:

[
  {
    "name": "balancer_emergency_percentage",
    "value": 75
  }
]

返回示例

{
  "duration": 3464,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-05T23:38:06.907+08:00",
  "traceId": "9d3721be71e94f25"
}

有帮助

无帮助