You can call this operation to restart a MongoDB instance.

This operation can also be used to restart a shard or mongos node in a replica set instance.

Debugging

OpenAPI Explorer simplifies API usage. You can use OpenAPI Explorer to perform debugging operations, such as retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes RestartDBInstance

The operation that you want to perform. Set the value to RestartDBInstance.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

NodeId String No d-bpxxxxxxxx

The ID of the shard or mongos in the sharded cluster instance.

Note The sharded cluster instance will be restarted if this parameter is not specified.
AccessKeyId String No LTAIgbTGpxxxxxx

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
RequestId String 149C517D-B586-47BE-A107-8673E0ED77C6

The ID of the request.

Examples

Sample requests


http(s)://mongodb.aliyuncs.com/? Action=RestartDBInstance
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Successful response examples

XML format

<RestartDBInstanceResponse> 
  <RequestId>149C517D-B586-47BE-A107-8673E0ED77C6</RequestId>
</RestartDBInstanceResponse> 

JSON format

{
	"RequestId":"149C517D-B586-47BE-A107-8673E0ED77C6"
}

Error codes

View error codes