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
Name |
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 Parameters
- Parameter description
Table 2 Request body parameters Name
Mandatory
Type
Description
num
No
Integer
Definition
Number of nodes to be deleted.
Constraints
N/A
Range
N/A
Default Value
N/A
node_list
No
Array of strings
Definition
ID list of nodes to be deleted.
Constraints
- 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.
Range
N/A
Default Value
N/A
- Example request 1:
{ "num" : 2 }
- Example request 2:
{ "node_list" : [ "116ba14da34a42d28ecd83a38c218907no02", "642597740d884b9eb998338859eea6ceno02" ] }
Response Parameters
- Parameter description
Table 3 Response body parameters Name
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot