Updated on 2026-09-22 GMT+08:00

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 instance:

GeminiDB Redis

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:updateLoadBalance	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:modifyInstanceLb	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	Definition Whether to enable the blacklist or whitelist of load balancer IP addresses. Constraints N/A Range true: enabled false: disabled Default Value N/A
type	Yes	String	Definition Type of IP address access control for load balancers. This parameter is used to configure the filtering rules for the IP address access blacklist or whitelist. Constraints N/A Range whiteList: Access is restricted to specified IP addresses or CIDR blocks. blackList: Access is denied for specified IP addresses or CIDR blocks. Default Value N/A
ip_groups	Yes	Array of IpGroupItem objects	Definition IP addresses or CIDR blocks in the IP address group. Constraints N/A

**Table 4** IpGroupItem
Parameter	Mandatory	Type	Description
ip	Yes	String	Definition IP address or CIDR block. Constraints Both IPv4 and IPv6 are supported. Range IPv4 address (for example, 192.168.1.1) IPv4 CIDR block (for example, 192.168.1.0/24) IPv6 address (for example, 2001:db8::1) IPv6 CIDR block (for example, 2001:db8::/32) Default Value N/A
description	No	String	Definition Supplementary information. Constraints It can contain a maximum of 255 characters. Range N/A Default Value N/A

Response Parameters

Status code: 200

None

Example Requests

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" 
   } ] 
 }

Example Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instance Load Balancing Management