Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instance Load Balancing Management/ Querying the Blacklist or Whitelist of Load Balancer IP Addresses
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Querying the Blacklist or Whitelist of Load Balancer IP Addresses

Function

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

Constraints

This API supports the following type of instances:

  • 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:getLoadBalance

    Read

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:list

    -

URI

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enabled

Boolean

The value true indicates that this function is enabled, and false indicates that this function is disabled.

type

String

Type.

The value can be:

  • whiteList, indicating that specified IP addresses or CIDR blocks are allowed.
  • blackList, indicating that specified IP addresses or CIDR blocks are not allowed.

ip_groups

Array of objects

IP addresses or CIDR blocks in the IP address group. For details, see Table 4.
Table 4 IpGroupItem

Parameter

Type

Description

ip

String

IP address or CIDR block. IPv4 and IPv6 addresses are supported.

description

String

Supplementary information. The value consists of 0 to 255 characters.

Example Request

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

Example Response

Status code: 200

Success

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.