Help Center> Document Database Service> API Reference> APIs V3.0 (Recommended)> DB Instance Management> Configuring Cross-CIDR Access for a Replica Set
Updated on 2022-12-12 GMT+08:00
View PDF

Configuring Cross-CIDR Access for a Replica Set

API Description

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

Restrictions

Only replica set instances are supported.

URI

  • URI format

    POST https://{Endpoint}/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 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    client_network_ranges

    Array of strings

    Yes

    CIDR block where the client is located

    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.
  • Request example
{ 
    "client_network_ranges":["192.168.0.0/16"] 
}

Responses

  • Response example
    {}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management