Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Deleting a Read Replica of an Instance
Updated on 2025-12-02 GMT+08:00
View PDF
Share

Deleting a Read Replica of an Instance

API Description

This API is used to delete a read replica.

Constraints

  • Only replica set instances have read replicas.
  • Read replicas cannot be deleted from instances that have abnormal nodes.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dds:instance:reduceNode

    write

    instance

    g:EnterpriseProjectId

    -

    -

URI

  • URI format

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

  • URI example

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/readonly-node

Table 1 Request Parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

project_id

string

path

Yes

Definition

Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

string

path

Yes

Definition

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

  • Parameter description
    Table 2 Request body parameters

    Parameter

    Mandatory

    Type

    Description

    node_list

    Yes

    Array of strings

    Definition

    List of read replica IDs.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A
  • Example request 
    { 
   "node_list": ["a66ae943020e49ed842dc6aa80ab2a13no02"]  
 }

Response

  • Parameter description
    Table 3 Response body parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task ID. This parameter is returned only for pay-per-use DB instances.

    Range

    N/A

    order_id

    String

    Definition

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

    Range

    N/A
  • Example Response 
    { 
  "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc"  
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management