Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Configuring Access to a Replica Set Across CIDR Blocks
Updated on 2025-07-02 GMT+08:00
View PDF
Share

Configuring Access to a Replica Set Across CIDR Blocks

Function

This API is used to configure access to a replica set across CIDR blocks.

Constraints

This API supports the following types of instances:

  • GeminiDB Mongo

This operation is not supported for frozen or abnormal instances.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

client_network_ranges

Yes

Array of strings

Explanation:

CIDR block assigned to a client

Constraints:

To ensure the ECS and instance can communicate with each other, configure the connection by following VPC Peering Connection Overview.

Values:

  • Only when different CIDR blocks are assigned for a client and a replica set instance, for example, 192.168.0.0/16 and 172.16.0.0/24, you need to modify network configurations to allow access from the client (192.168.0.0/16).
  • For example, if the source CIDR block is 192.168.0.0/xx, xx must range from 8 to 32.

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

Task ID.

Values:

N/A

Example Requests

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in10/client-network
  • Changing the CIDR block where the client is located to 192.168.0.0/16 
    { 
  "client_network_ranges" : [ "192.168.0.0/16" ] 
}

Example Responses

Status code: 202

Accepted

{ 
  "job_id" : "89638f5e-0780-497c-b3c0-4d0968383e19" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances