Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Instances> Configuring Access to a Replica Set Across CIDR Blocks
Updated on 2023-11-21 GMT+08:00
View PDF

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 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, which can be obtained by calling the API described in Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

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

client_network_ranges

Yes

Array of strings

CIDR block where the client is located.

  • Access across CIDR blocks is required only when the CIDR blocks of the client and the replica set instance are different. For example, if the client CIDR block is 192.168.0.0/16 and the replica set instance's CIDR block is 172.16.0.0/24, add the CIDR block 192.168.0.0/16 so that the client can access the replica set instance.
  • For example, if the source network segment is 192.168.0.0/xx, the value of xx must range from 8 to 32.
  • To ensure the ECS and the instance can communicate with each other, configure the connection by referring to VPC Peering Connection Overview.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

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