Updated on 2025-12-15 GMT+08:00

Rebooting a DB Instance

Function

This API is used to reboot a DB instance.

The FlexusRDS instance will be unavailable during the reboot. Exercise caution when performing this operation.

Constraints

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

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 identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    rds:instance:restart

    write

    instance

    g:EnterpriseProjectId

    g:ResourceTag/<tag-key>

    -

    -

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Definition

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    String

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

restart

Yes

None

Definition

Whether to reboot the instance.

Range

Left blank

Example Request

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

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task ID.

    Range

    N/A

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

    For details, see Abnormal Request Results.

Status Code