Stops an instance that is created in a dedicated cluster.

Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see What is ApsaraDB for MyBase?

  • After you stop an instance, the computing resources of the instance are released. However, the data of the instance is retained. The retained data can be used to start the instance. For more information, see StartDBInstance.
  • When you stop an instance, all the read-only instances that are attached to the instance are stopped at the same time.
  • After you stop an instance, its storage resources are also retained. You do not need to pay extra fees for the storage of the retained data.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopDBInstance

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

DBInstanceId String Yes rm-bpxxxxx

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String A417FB41-A3D9-464E-AD0A-C7FE05C72E98

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=StopDBInstance
&DBInstanceId=rm-bpxxxxx
&<Common request parameters>

Sample success responses

XML format

<StopDBInstanceResponse>
    <RequestId>A417FB41-A3D9-464E-AD0A-C7FE05C72E98</RequestId>
</StopDBInstanceResponse>

JSON format

{
    "RequestId": "A417FB41-A3D9-464E-AD0A-C7FE05C72E98"
}

Error codes

For a list of error codes, visit the API Error Center.