Configuring the Blacklist or Whitelist of Load Balancer IP Addresses

Function

This API is used to configure the blacklist or whitelist of load balancer IP addresses. The previous settings are overwritten each time this API is called. After this function is disabled, the source IP address of the connection is not restricted.

Constraints

This API supports the following types of instances:

GeminiDB Redis

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	The value true indicates that this function is enabled, and false indicates that this function is disabled.
type	Yes	String	Type. The value can be: whiteList, indicating that only specified IP addresses or CIDR blocks are allowed. blackList, indicating that specified IP addresses or CIDR blocks are not allowed.
ip_groups	Yes	Array of objects	IP addresses or CIDR blocks in the IP address group. For details, see Table 4.

**Table 4** IpGroupItem
Parameter	Mandatory	Type	Description
ip	Yes	String	IP address or CIDR block. IPv4 and IPv6 addresses are supported.
description	No	String	Supplementary information. The value consists of 0 to 255 characters.

Response Parameters

Status code: 200

None

Example Request

Adding the CIDR block 123.123.123.0/24 to the blacklist

PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control 
  
 { 
   "type" : "blackList", 
   "enabled" : true, 
   "ip_groups" : [ { 
     "ip" : "123.123.123.0/24", 
     "description" : "test" 
   } ] 
 }

Disabling the load balancing blacklist and whitelist

PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control 
  
 { 
   "type" : "blackList", 
   "enabled" : false, 
   "ip_groups" : [ { 
     "ip" : "123.123.123.123", 
     "description" : "test" 
   } ] 
 }