修改租户白名单 | OceanBase 文档中心

修改租户白名单

更新时间：2023-08-09 10:10:56

功能说明

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

调用说明

接口约束

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

请求路径

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

path:

参数	类型	必选	示例值	描述
id	Long	是	1	集群 ID
tenantId	Long	是	1	租户 ID

请求参数

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

返回结果

基础数据结构

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

示例

请求示例

POST /api/v2/ob/clusters/1/tenants/2/modifyWhitelist

body:

{
  "whitelist": "1.1.1.1"
}

返回示例

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