All Products
Search

This Product

    ApsaraDB for MongoDB:RestartDBInstance

    Document Center

    ApsaraDB for MongoDB:RestartDBInstance

    Last Updated:Apr 03, 2025

    Restarts an ApsaraDB for MongoDB instance.

    Operation description

    This operation can also be used to restart an instance, or restart a shard or mongos node in a sharded cluster instance.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID.

    		dds-bpxxxxxxxx
    NodeIdstringNo

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

    Note The sharded cluster instance is restarted if you do not specify this parameter.
    		d-bpxxxxxxxx

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		149C517D-B586-47BE-A107-8673E0ED77C6

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-07-13The internal configuration of the API is changed, but the call is not affectedView Change Details