Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Deleting a Read Replica
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Deleting a Read Replica

Function

This API is used to delete a read replica. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

DELETE /v3/{project_id}/instances/{instance_id}/readonly-nodes

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 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 the request is processed, the value of X-Subject-Token in the message header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Request parameters

Parameter

Mandatory

Type

Description

node_ids

Yes

Array of strings

Definition

IDs of read replicas to be deleted.

Constraints

N/A

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

job_id

String

Definition

ID of the job for deleting read replicas.

Range

N/A

Example Request

DELETE https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/95e33e5453684df9a300973f28751b5din14/readonly-nodes
{
  "node_ids": [
    "dd33c79dba6c4375b520c792a1713030no14"
  ]
}

Example Response

{ 
  "job_id" : "490a4a08-ef4b-44c5-94be-3051ef9e4fce" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Instance Management