DeleteNode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, make sure that the instance meets the following requirements:

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DeleteNode

delete

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx
NodeId	string	Yes	The ID of the shard or mongos node that you want to delete. You can call the DescribeDBInstanceAttribute operation to query node IDs.	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 token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.