修改租户 Zone 优先级 - 云平台 OCP V4.3.0 | OceanBase 文档中心

文档反馈

V4.3.0

文档概览
产品简介
部署 OceanBase 云平台
升级 OceanBase 云平台
快速入门
集群管理
租户管理
OBProxy 管理
主机管理
告警中心
监控大盘
性能监控
诊断调优
运维管理
备份恢复
容灾管理
日志服务
软件包管理
系统管理
SQL 调优实践
运维最佳实践
参考指南
- 告警参考
- API 参考
  - 概述
  - API 调用说明
  - AK/SK 签名生成规则
  - 任务返回结构
  - 集群信息
  - 租户信息
    - 查询集群的租户列表
    - 查询全部租户列表
    - 查询租户详情
    - 创建租户
    - 创建租户（不推荐使用）
    - 删除租户
    - 锁定租户
    - 解锁租户
    - 查询租户 Unit 列表
    - 删除租户 Unit
    - 增加租户副本
    - 删除租户副本
    - 修改租户副本
    - 修改租户 Zone 优先级
    - 修改租户管理密码
    - 修改租户白名单
    - 获取租户参数列表
    - 修改租户参数
    - OceanBase 数据库管理
    - 获取 unit 规格列表
    - 创建资源单元规格
    - 删除资源单元规格
  - 主机模块
  - 软件包接口
  - OBProxy 管理
  - 监控
  - 告警
  - 巡检
  - 任务管理接口
  - OCP 历史事件
  - OceanBase 用户与权限管理
  - OCP Agent 管理
  - SQL 性能
  - 备份恢复
  - 健康检查
  - 性能报告
- 监控指标参考
常见问题
附录
版本发布记录

修改租户 Zone 优先级

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

分享

功能说明

修改指定租户的 Zone 优先级时使用的接口。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

请求路径

POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/modifyPrimaryZone

请求参数

path：

参数	类型	必选	示例值	描述
id	Long	是	1000001	目标租户所属集群在 OCP 端的集群 ID。
tenantId	Long	是	1000002	目标租户在 OCP 端的租户 ID。

body：

参数	类型	必选	示例值	描述
primaryZone	String	是	zone1;zone2,zone3	Zone 优先级。

返回结果

基础数据结构

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

示例

请求示例

POST /api/v2/ob/clusters/1000001/tenants/1000002/modifyPrimaryZone

{
  "primaryZone": "zone1;zone2,zone3"
}

返回示例

{
"duration": 233,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-03-02T16:02:24.643+08:00",
"traceId": "49556176bcfe439b"
}

有帮助

无帮助