RestartNode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Limitations:

The instance must be in the Running state.
The instance must be a standard replica set instance or a sharded cluster instance.

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:RestartNode

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If the instance is a sharded cluster instance, also set the `NodeId` parameter.	dds-bpxxxxxxxx
NodeId	string	No	The ID of the Mongos, shard, or Configserver node in the sharded cluster instance. Call the DescribeDBInstanceAttribute operation to query the node ID. Note This parameter is required if DBInstanceId is set to the ID of a sharded cluster instance.	d-bp128a003436****
RoleId	string	Yes	The role ID of the node. Call the DescribeReplicaSetRole operation to query the role ID of a node in a replica set instance. Call the DescribeRoleZoneInfo operation to query the role ID of a node in a sharded cluster instance.	6025****
SwitchMode	string	No	The time to execute the task. Valid values: 0: The task is executed immediately. This is the default value. 1: The task is executed during the maintenance window. Note Call the ModifyInstanceMaintainTime operation to modify the maintenance window of the instance.	1

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.