Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Deleting Instance Nodes
Updated on 2023-11-24 GMT+08:00
View PDF
Share

Deleting Instance Nodes

API Description

This API is used to delete instance nodes.

Restrictions

  • This API applies only to replica set instances.
  • For a 7-node replica set instance, two or four standby nodes can be deleted.
  • For a 5-node replica set instance, two standby nodes can be deleted.
  • The standby node of a 3-node replica set instance cannot be deleted.
  • Nodes cannot be deleted from instances that have abnormal nodes.

URI

  • URI format

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

  • URI example

    https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/nodes

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

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

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Requests

  • Parameter description
    Table 2 Request body parameters

    Name

    Mandatory

    Type

    Description

    num

    No

    Integer

    Number of nodes to be deleted.

    node_list

    No

    Array of strings

    ID list of nodes to be deleted.

    • Either num or node_list must be set.
    • If both num and node_list are specified, the value of node_list takes effect.
    • The role of the node to be deleted cannot be Primary or Hidden.
    • If there is a multi-AZ instance, ensure that at least one node is deployed in each AZ after specified nodes are deleted.
  • Example request 1: 
    { 
   "num" : 2 
 }
  • Example request 2: 
    { 
   "node_list" : [ 
                   "116ba14da34a42d28ecd83a38c218907no02",  
                   "642597740d884b9eb998338859eea6ceno02" ] 
 }

Responses

  • Parameter description
    Table 3 Response body parameters

    Name

    Type

    Description

    job_id

    String

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

    order_id

    String

    Order ID. This parameter is returned only for yearly/monthly DB instances.
  • 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