文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例负载均衡管理/ 设置实例负载均衡的IP访问黑白名单
更新时间:2023-11-24 GMT+08:00
分享

设置实例负载均衡的IP访问黑白名单

功能介绍

设置实例负载均衡的IP访问黑白名单,黑名单、白名单只能选一种,每次调用此接口覆盖之前的设置。关闭后不限制连接的源IP地址。

接口约束

该接口支持如下数据库实例:

  • GeminiDB Redis

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/lb/access-control

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

true:开启,false:关闭。

type

String

类型选项。

取值:

  • whiteList:白名单,只允许指定ip或网段访问。
  • blackList:黑名单,不允许指定ip或网段访问。

ip_groups

Array of objects

IP地址组中包含的IP或网段列表。详情请参考表4

表4 IpGroupItem

参数

是否必选

参数类型

描述

ip

String

IP地址或网段。支持IPv4、IPv6。

description

String

备注信息。长度:最小长度 0,最大长度 255。

响应参数

状态码: 200

无响应参数。

请求示例

  • ip网段123.123.123.0/24被设置成黑名单
    PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control 
      
     { 
       "type" : "blackList", 
       "enabled" : true, 
       "ip_groups" : [ { 
         "ip" : "123.123.123.0/24", 
         "description" : "test" 
       } ] 
     }
  • 关闭负载均衡黑白名单
    PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control 
      
     { 
       "type" : "blackList", 
       "enabled" : false, 
       "ip_groups" : [ { 
         "ip" : "123.123.123.123", 
         "description" : "test" 
       } ] 
     }

响应示例

无。

状态码

请参见状态码

错误码

请参见错误码

相关文档