Stopping an Instance¶
Function¶
This API is used to stop a pay-per-use DB instance. The instance can be stopped for up to seven days.
Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.
Constraints¶
This API is supported for MySQL and PostgreSQL DB engines.
If you stop a primary instance, read replicas (if there are any) will also be stopped. They are stopped for up to seven days. You cannot stop a read replica without stopping the primary instance.
A stopped MySQL DB instance will not be moved to the recycle bin after being deleted.
A stopped PostgreSQL DB instance cannot be deleted.
If you do not manually start your stopped DB instance after seven days, your DB instance is automatically started during the next maintenance window.
After an instance is stopped, the ECS is no longer billed. Other resources, including EIPs, storage resources, and backups, are still billed.
An instance cannot be stopped if it is in any of the following statuses:
Creating, rebooting, scaling up, changing instance class, restoring, and changing port
URI¶
URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action/shutdown
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
Yes
Instance ID.
Request¶
Parameter description
None
Example
Request example
{}
Response¶
Normal response
Table 2 Parameter description¶ Name
Type
Description
job_id
String
Job ID.
Example normal response
{ "job_id": "2b414788a6004883a02390e2eb0ea227" }Abnormal response
For details, see Abnormal Request Results.
Status Code¶
Normal
200
Abnormal
For details, see Status Codes.
Error Code¶
For details, see Error Codes.