DeleteNode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

You can call this operation to delete a shard or mongos node in a sharded cluster instance.

Operation Description

Before you call this operation, make sure that the following requirements are met:

The instance is in the running state.
The instance is a sharded cluster instance.
The billing method of the instance is pay-as-you-go.
The number of the shard or mongos nodes in the instance is greater than two.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DeleteNode	WRITE	DBInstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	dds-bpxxxxxxxx
NodeId	string	Yes	The ID of the shard or mongos node to be deleted. You can call the DescribeDBInstanceAttribute operation to query the node ID.	s-bpxxxxxxxx
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
TaskId	integer	The ID of the task.	111111111
RequestId	string	The ID of the request.	9F9BDE64-BF30-41F3-BD29-C19CE4AB3404
OrderId	string	The order ID of the instance.	111111111111111

Examples

Sample success responses

JSONformat

{
  "TaskId": 111111111,
  "RequestId": "9F9BDE64-BF30-41F3-BD29-C19CE4AB3404",
  "OrderId": "111111111111111"
}

Error codes

For a list of error codes, visit the Service error codes.