Updated on 2025-10-24 GMT+08:00

Configuring Cross-CIDR Access for a Replica Set

API Description

This API is used to configure cross-CIDR access for a replica set instance.

Constraints

Only replica set instances are supported.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/client-network

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/client-network

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

string

path

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

IN

Description

X-Auth-Token

Yes

string

header

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Parameter description

Name

Type

Mandatory

Description

client_network_ranges

Array of strings

Yes

Definition

CIDR block where the client is located

Constraints

NOTE:
  • Cross-CIDR access 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. This function is available only for replica sets.
  • 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 DB instance can communicate with each other, configure the connection by referring to VPC Peering Connection Overview.

Range

N/A

Default Value

N/A

Example Requests

Configuring access across CIDR blocks for a replica set instance

{ 
    "client_network_ranges":["192.168.0.0/16"] 
}

Response Parameters

None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.