Deleting 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:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI¶

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

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DB instance ID, which is compliant with the UUID format.
node_id	Yes	String	Node ID, which is compliant with the UUID format.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
job_id	String	Task ID.

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¶

DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07

Example Response¶

Status code: 200

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-11-04 10:22 UTC - commit: b4fc2eaf26efa1bee7e90ca08418c96971251ae1