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

Rebuilding a Standby Instance

Function

This API is used to rebuild a standby instance to eliminate the replication delay.

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:update

write

-

-

rds:instance:modify

-

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/rebuild

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/rebuild

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    instance_id

    String

    Definition

    Instance ID.

    Range

    N/A

    workflow_id

    String

    Definition

    Task flow ID.

    Range

    N/A
  • Example normal response 
    {
    "instance_id":"08dbfde762034d5a9ace8f73c156e2e5in01",
    "workflow_id":"159a2a0a-c9a6-49b8-8e15-72e2ed2cad59"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management