修改 OceanBase 集群密码 | OceanBase 文档中心

文档反馈

V4.0.3企业版

文档概览
产品简介
部署指南
快速入门
用户指南
监控指标参考
故障处理
告警参考
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 的服务器列表
- 租户信息
- 主机模块
- 软件包接口
- OBProxy 管理
- 监控
- 告警
- 任务管理接口
- OCP 历史事件
- OB 用户与权限管理
- OCP Agent 管理
- SQL 性能
- 备份恢复
- 其它
- 附录
常见问题
版本发布记录

修改 OceanBase 集群密码

更新时间：2023-08-16 15:51:32

分享

功能说明

该接口用于修改目标 OceanBase 集群的密码。

调用说明

接口约束

调用者需具备对目标 OceanBase 集群的更新权限。

关于调用者的权限，详情可参见安全概述。
调用者需要通过 OCP 应用服务鉴权。

请求路径

POST /api/v2/ob/clusters/{id}/changePassword

path：

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

请求参数

参数	类型	必选	示例值	描述
newPassword	String	是	foo	新密码。
saveToCredential	Boolean	否	true	是否保存到密码箱。

返回结果

基础数据结构

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

示例

请求示例

POST /api/v2/ob/clusters/1/changePassword

返回示例

{
  "duration": 425,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-05T22:56:48.538+08:00",
  "traceId": "bfc0defbcd0a453d"
}

有帮助

无帮助