Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DR Instances/ Configuring the DR Capability for a DR Instance
Updated on 2024-08-28 GMT+08:00

Configuring the DR Capability for a DR Instance

Function

This API is used to configure DR for a DR instance when establishing a cross-cloud or cross-region DR relationship.

Before using this function, ensure that the network between the VPC CIDR blocks of the DB instances across clouds or regions is connected, and configure security group rules to allow access from database ports in the VPC CIDR blocks. The DR relationship cannot be established if only the network is connected but security group rules are not configured.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • The DR instance cannot be configured for DR until the primary DB instance is configured.
  • The primary DB instance and DR instance are available and are deployed in different clouds or regions. The DR instance is deployed in standalone mode.
  • The specifications of the DR instance are at least equal to those of the primary DB instance.
  • The underlying architecture and major version of the DR instance must be the same as those of the primary DB instance.
  • After the API for configuring DR for the DR instance is called, you cannot change the instance class or perform a primary/standby switchover until the DR relationship is set up.
  • RDS for PostgreSQL 12 and later versions support cross-cloud or cross-region DR.
  • Cross-cloud or cross-region DR relationships cannot be established across major versions.
  • After a DR instance is set up, a minor version upgrade cannot be performed.
  • Modifying a parameter of the primary instance do not modify that of the DR instance synchronously. You need to modify the parameter of the DR instance separately based on service requirements.
  • RDS for PostgreSQL DR instances do not support point-in-time recovery (PITR) or CBR snapshot-based backups. Perform such operations on the primary instance if needed.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/action

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

build_slave_dr_relation

Yes

Object

Specifies the primary DB instance information required for configuring the DR relationship for the DR instance.

For details, see Table 3.

Table 3 build_slave_dr_relation field description

Name

Mandatory

Type

Description

target_instance_id

Yes

String

Specifies the ID of the primary DB instance.

target_project_id

Yes

String

Specifies the project ID of the tenant to which the primary DB instance belongs.

target_region

Yes

String

Specifies the ID of the region where the primary DB instance resides.

target_ip

Yes

String

Specifies the data VIP of the primary DB instance.

Example Request

Configure a DR relationship for a DR instance, with the primary DB instance deployed in region aaa.
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/action 
{
    "build_slave_dr_relation": {
           "target_instance_id":"c39bd176fb0540929f6add80b91b212cin03",
           "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd",
           "target_region":"aaa",
           "target_ip":"192.168.3.238"
     }
}

Response

  • Normal response
    Table 4 Parameter description

    Name

    Type

    Description

    job_id

    String

    Workflow ID.

  • Example normal response
    {
    	"job_id": "184f29cd-be1a-43f1-5b6bc5500e73"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.