---
title: "修改租户白名单 - 云平台 OCP V4.3.0 | OceanBase 文档中心"
description: "修改租户白名单 功能说明 修改指定租户的白名单时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/modifyWhitelist 请求参数 path： 参数 类型 必选 示例值 描述 i…"
---
切换语言

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

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

# 修改租户白名单

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

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/500.tenant-information/1600.modify-the-tenant-whitelist.md)  

## 功能说明

修改指定租户的白名单时使用的接口。

## 调用说明

### 接口约束

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

### 请求路径

`POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/modifyWhitelist`

### 请求参数

**path：**

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

**body：**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| whitelist | String | 是 | xxx.xxx.xxx.xxx | 访问白名单。- 可以填写 IP 地址（如 xxx.xxx.xxx.xxx）或 IP 段（如 xxx.xxx.xxx.xxx/24） - 多个 IP 需要用英文逗号隔开，如 xxx.xxx.xxx.xxx,xxx.xxx.xxx.xxx/24 - xxx.xxx.xxx.xxx 表示禁止任何 IP 地址访问 |

### 返回结果

**基础数据结构**

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

## 示例

### 请求示例

`POST /api/v2/ob/clusters/1000001/tenants/1000002/modifyWhitelist`

```json
{
  "whitelist": "xxx.xxx.xxx.xxx"
}

```

### 返回示例

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

```

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