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

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.

Constraints

  • If you start a primary instance, read replicas (if there are any) will also be started.
  • Only instances in Stopped state can be started.
  • A stopped pay-per-use DB instance may fail to be started due to insufficient resources. In this case, contact customer service.

URI

  • URI format

    POST /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

None

Example Request

POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/startup

{}

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    job_id

    String

    Task ID.

  • Example normal response
    {
        "job_id": "2b414788a6004883a02390e2eb0ea227"
    }

Status Code

Error Code

For details, see Error Codes.