更新时间:2023-12-18 GMT+08:00

创建白名单

功能介绍

创建白名单,控制监听器的访问权限。若开启了白名单功能,只有白名单中放通的IP可以访问该监听器的后端服务。

URI

POST /v2.0/lbaas/whitelists

请求消息

表1 请求参数

参数

是否必选

参数类型

描述

whitelist

Object

白名单对象。详见表2

表2 whitelist字段说明

参数

是否必选

参数类型

描述

tenant_id

String

白名单所在的项目ID。

需要和token中的project_id一致。

支持的最大字符长度:255

listener_id

String

监听器ID。

一个监听器只能创建一个白名单。

enable_whitelist

Boolean

是否开启访问控制开关。

true:打开

false:关闭

默认值:true。

whitelist

String

白名单IP的字符串。不同IP之间通过逗号分隔。

可以指定一个IP,例如:

192.168.11.1

也可以指定网段,例如:

192.168.0.1/24

默认值:“”。

响应消息

表3 响应参数

参数

参数类型

描述

whitelist

Object

白名单对象。详见表4

表4 whitelist字段说明

参数

参数类型

描述

id

String

白名单的ID。

tenant_id

String

白名单所在的项目ID。

支持的最大字符长度:255

listener_id

String

白名单关联的监听器ID。

enable_whitelist

Boolean

是否开启访问控制开关。

true:打开

false:关闭

whitelist

String

白名单IP的字符串。

请求示例

  • 请求样例 创建白名单
    POST https://{Endpoint}/v2.0/lbaas/whitelists 
    
    { 
        "whitelist": { 
            "listener_id": "eabfefa3fd1740a88a47ad98e132d238",  
            "enable_whitelist": true,  
            "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" 
        } 
    }

响应示例

  • 响应样例
    { 
        "whitelist": { 
            "id": "eabfefa3fd1740a88a47ad98e132d238",  
            "listener_id": "eabfefa3fd1740a88a47ad98e132d238",  
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",  
            "enable_whitelist": true,  
            "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" 
        } 
    }

返回码

请参见状态码