Configuring the DR Capability for a Primary DB Instance

Function

This API is used to configure DR for a primary DB 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 while security group rules are not configured.

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

Constraints

• The primary DB instance and DR instance are available and are deployed in different clouds or regions. The primary DB instance is deployed in primary/standby mode and 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 primary 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 and this function is in OBT.
• Cross-cloud or cross-region DR relationships cannot be established across major versions.

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

Example Request

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/action 
{
    "build_master_dr_relation": {
           "target_instance_id":"c39bd176fb0540929f6add80b91b212cin03",
           "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd",
           "target_region":"aaa",
           "target_ip":"192.168.3.238",
           "target_subnet":"192.168.3.1/24"
    }
}

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

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.