Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ DR Management/ Promoting the DR instance to Primary
Updated on 2025-08-19 GMT+08:00
View PDF
Share

Promoting the DR instance to Primary

Function

This API is used to promote the DR instance to primary if the primary instance is unavailable. Before calling this API:

Constraints

It can be delivered only from the DR region.

URI

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/failover

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

is_support_restore

No

Boolean

Definition

Whether a DR relationship can be re-established for the instance.

Constraints

This parameter is only available for the scenario where streaming DR is used and the DB engine version is V2.0-3.200 or later.

Range

  • true: A DR relationship is re-established for the instance.
  • false (default value): A DR relationship is not re-established for the instance.

Default Value

false

disaster_type

Yes

String

Definition

DR type.

Constraints

N/A

Range

  • stream: streaming DR.

Default Value

N/A

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

N/A

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/failover
{
  "is_support_restore": true,
  "disaster_type": "stream"
}

Example Response

{ 
    "job_id":"8bf0175e-562e-45f6-942a-2e2c72c577d7" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: DR Management