更新时间:2022-08-15 GMT+08:00

更新白名单

功能介绍

更新白名单。可以打开或关闭白名单,或更新访问控制的IP。更新白名单后,会删除老的白名单,以新的白名单替换老的白名单。

URI

PUT /v2.0/lbaas/whitelists/{whitelist_id}

表1 参数说明

参数

是否必选

参数类型

描述

whitelist_id

String

白名单ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

whitelist

Object

白名单对象。详见表3

表3 whitelist字段说明

参数

是否必选

参数类型

描述

enable_whitelist

Boolean

是否开启访问控制开关。

true:打开

false:关闭

默认值:true。

whitelist

String

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

可以指定一个IP,例如:

192.168.11.1

也可以指定网段,例如:

192.168.0.1/24

默认值:“”。

响应消息

表4 响应参数

参数

参数类型

描述

whitelist

Object

白名单对象。详见表5

表5 whitelist字段说明

参数

参数类型

描述

id

String

白名单的ID。

tenant_id

String

白名单所在的项目ID。

支持的最大字符长度:255

listener_id

String

白名单关联的监听器ID。

enable_whitelist

Boolean

是否开启访问控制开关。

true:打开

false:关闭

whitelist

String

白名单IP的字符串。

请求示例

  • 请求样例 更新白名单
    PUT https://{Endpoint}/v2.0/lbaas/whitelists/dcaf46f1-037c-4f63-a31f-e0c4c18032c7 
    
    { 
        "whitelist": { 
            "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" 
        } 
    }

返回码

请参见状态码