Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ DR Management/ Stopping a DR Relationship
Updated on 2026-07-16 GMT+08:00
View PDF
Share

Stopping a DR Relationship

Function

This API is used to stop a DR relationship (initiated from the primary instance). Before calling this API:

Constraints

  • Stopping a DR relationship can be initiated only from the primary region.
  • There is a DR relationship between primary instance A and DR instance B. When a streaming DR drill is performed on the DR instance B, you cannot remove the DR relationship from the primary instance A.

Debugging

You can debug this API in API Explorer.

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

String

Definition

Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

disaster_type

Yes

String

Definition

DR type.

Constraints

N/A

Range

  • stream: streaming DR.

Default Value

N/A

Response Parameters

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

The value can contain 36 characters, including letters, digits, and hyphens (-).

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/release
{ 
	"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