---
title: "修改 OceanBase 集群密码 | OceanBase 文档中心"
description: 修改 OceanBase 集群密码 功能说明 该接口用于修改目标 OceanBase 集群的密码。 调用说明 接口约束 调用者需具备对目标 OceanBase 集群的更新权限。 关于调用者的权限，详情可参见 安全概述 。 调用者需要通过 OCP 应用服务鉴权。 请求路径 POST /api/v2/ob/cluster…
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 修改 OceanBase 集群密码

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

## 功能说明

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

## 调用说明

### 接口约束

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

  关于调用者的权限，详情可参见 [安全概述](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001538756)。
 - 调用者需要通过 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`

### 返回示例

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

```

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