RestartNode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Restarts a node in an ApsaraDB for MongoDB instance.

Operation description

You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.

Note When you call this operation, the instance must meet the following requirements:

The instance is in the Running state.
The instance is a replica set or sharded cluster instance of the standard edition.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:RestartNode	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.	dds-bpxxxxxxxx
NodeId	string	No	The ID of the shard, mongos, or ConfigServer node in a child instance of the sharded cluster instance. Note If you set the DBInstanceId parameter to the ID of a sharded cluster instance, you must specify this parameter.	d-bp128a003436****
RoleId	string	Yes	The role ID of the node. You can call the DescribeReplicaSetRole operation to query the role ID of a node in a replica set instance. You can call the DescribeRoleZoneInfo operation to query the role ID of a node in a sharded cluster instance.	6025****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	ECBCA991-XXXX-XXXX-834C-B3E8007F33AA

Examples

Sample success responses

JSONformat

{
  "RequestId": "ECBCA991-XXXX-XXXX-834C-B3E8007F33AA"
}

Error codes

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