Updated on 2024-06-07 GMT+08:00

Rebooting a DB Instance

Function

This API is used to reboot a DB instance.

  • Before calling an API, you need to understand the API in Authentication.

The RDS DB instance will be unavailable during the reboot process. Exercise caution when performing this operation.

Constraints

The DB instance cannot reboot when it is being created, scaled, backed up, frozen, restored, or its instance class or port is being changed.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/action

  • 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

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

restart

Yes

None

This parameter is left blank.

Example Request

Reboot a DB instance.
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action

{
      "restart": {}
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Task ID.

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

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.