Help Center> GaussDB> API Reference> API> Managing DB Instances> Deleting a Read Replica
View PDF

Deleting a Read Replica

Function

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

URI

  • URI format

    DELETE https://{Endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id}

  • Example

    DELETE https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    instance_id

    Yes

    DB instance ID, which is compliant with the UUID format.

    node_id

    Yes

    Read-only node ID, which is compliant with the UUID format.

Request

None

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    job_id

    String

    ID of the task for deleting a read replica.
  • Example normal response 
    {
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances