Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Deleting or Unsubscribing from a Read Replica
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Deleting or Unsubscribing from a Read Replica

Function

This API is used to delete a read replica. For multi-AZ deployment, the primary node and remaining read replicas must be located in different AZs after read replicas are deleted. Before calling this API:

URI

DELETE /v3/{project_id}/instances/{instance_id}/nodes/{node_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

node_id

Yes

String

Definition

Node ID.

Constraints

N/A

Range

The value contains 36 characters, starting with a UUID and ending with no07. 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. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

order_id

String

Definition

Order ID. This parameter is only returned for yearly/monthly instances.

Range

N/A

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Deleting a read replica of a pay-per-use DB instance 
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07
  • Unsubscribing from a read replica of a yearly/monthly DB instance 
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07

Example Response

Status code: 200

Success.

  • Pay-per-use DB instance 
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
  • Yearly/monthly DB instance 
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890",
  "order_id" : "CS2305230939BMXV8"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management