Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Starting an Instance
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Starting an Instance

Function

This API is used to start a DB instance. You can stop your instance temporarily to save money. If your instance is stopped, you can restart it.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:start

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:operateServer

-

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 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, 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 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Task ID.
  • Example normal response 
    {
    "job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management