On this page

Show all

Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Deleting mongos Nodes

Deleting mongos Nodes

Updated on 2025-05-29 GMT+08:00

View PDF

Description

This API is used to reduce the number of mongos nodes in a cluster instance.

URI

URI format
DELETE /v3/{project_id}/instances/{instance_id}/mongos-node

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	Explanation: User token obtained from IAM. For details, see Authentication. Constraints: N/A Value range: N/A Default value: N/A
project_id	string	path	Yes	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	string	path	Yes	Explanation: 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 Value range: N/A Default value: N/A

Requests

Parameter description

**Table 2** Request body parameters
Name	Mandatory	Type	Description
node_list	Yes	Array of strings	Explanation: IDs of all mongos nodes to be deleted. At least two mongos nodes must be retained. Constraints: N/A Value range: N/A Default value: N/A

Example request:

Deleting the mongos node fea413b892214c53a58e5a529096ed75no02 from the instance 520c58ba00a3497e97ce0b9604874dd6in02

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/mongos-node    
{  
  "node_list" : [ "fea413b892214c53a58e5a529096ed75no02" ] 
 }

Responses

Parameter description

Status code: 202

**Table 3** Response body parameters
Name	Type	Description
job_id	String	Explanation: Task ID. This parameter is returned only for pay-per-use DB instances. Value range: N/A
order_id	String	Explanation: Order ID. This parameter is returned only for yearly/monthly DB instances. Value range: N/A

Status code: default

**Table 4** ErrorResponse
Name	Type	Description
error_code	String	Explanation: Error code returned when a task submission exception occurs. Value range: N/A
error_msg	String	Explanation: Error message returned when a task submission exception occurs. Value range: N/A

Example response

Status code: 202

Accepted.

{ 
  "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

Previous topic: Deleting a Read Replica of an Instance

Next topic: Querying Access Across CIDR Blocks for a Replica Set Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot