Starting an Instance¶
Function¶
This API is used to start a DB instance. You can stop your instance temporarily to save money. After stopping your instance, you can restart it to begin using it again.
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 start a primary instance, read replicas (if there are any) will also be started.
Only instances in Stopped state can be started.
URI¶
URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action/startup
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.