All Products
Search

This Product

    ApsaraDB for MongoDB:DeleteNode

    Document Center

    ApsaraDB for MongoDB:DeleteNode

    Last Updated:Jan 17, 2023

    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.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:DeleteNode WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
      without
    		without

    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

    Example

    Normal return example

    JSONFormat

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

    Error codes

    For a list of error codes, visit the API error center.