Stopping an Instance

Updated on 2024-03-28 GMT+08:00

View PDF

This API is used to stop a pay-per-use DB instance.

If you stop a primary instance, read replicas (if there are any) will also be stopped. You cannot stop a read replica without stopping the primary instance.
A stopped instance will not be moved to the recycle bin after being deleted.
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.

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.

Parameter description

None

Stopping an instance

{}

Normal response

**Table 2** Parameter description
Name	Type	Description
job_id	String	Task ID.

Example normal response

{
    "job_id": "2b414788a6004883a02390e2eb0ea227"
}

For details, see Error Codes.

Parent topic: DB Instance Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel