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

Querying the Blacklist or Whitelist of Load Balancer IP Addresses

This API is used to query the blacklist or whitelist of load balancer IP addresses.

This API supports the following instances:

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:getLoadBalance	Read	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:list	-

GET /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

**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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
enabled	Boolean	Definition Whether to enable the blacklist or whitelist of load balancer IP addresses. Range true: enabled false: disabled
type	String	Definition Type of IP address access control. Range whiteList: Access is restricted to specified IP addresses or CIDR blocks. blackList: Access is denied for specified IP addresses or CIDR blocks.
ip_groups	Array of IpGroupItem objects	Definition IP addresses or CIDR blocks in the IP address group.

**Table 4** IpGroupItem
Parameter	Type	Description
ip	String	Definition IP address or CIDR block. Range IPv4 and IPv6 addresses are supported.
description	String	Definition Remarks. The value can contain a maximum of 255 characters. Range N/A

GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control

Status code: 200

Success

{ 
  "type" : "blackList", 
  "ip_groups" : [ { 
    "ip" : "123.123.123.0/24", 
    "description" : "test" 
  } ], 
  "enabled" : true 
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Instance Load Balancing Management