Updated on 2025-09-24 GMT+08:00

Upgrading the Major Version of an RDS for MySQL Instance

Function

This API is used to upgrade an instance from MySQL 5.7 to MySQL 8.0.

Constraints

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/major-upgrade

  • Parameter description
    Table 1 Parameters

    Parameter

    Type

    Mandatory

    Description

    project_id

    String

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    String

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Type

Mandatory

Description

delay

Boolean

No

Definition

Whether the version is switched within the maintenance window.

Constraints

N/A

Range

  • true: The version is switched within the maintenance window.
  • false: The version is not switched within the maintenance window.

Default Value

false

configuration_id

String

No

Definition

Parameter template for the new version.

Constraints

If this parameter is left blank, the original instance parameters are inherited to the greatest extent by default.

Range

N/A

Default Value

N/A

Example Request

Upgrade an instance from MySQL 5.7 to MySQL 8.0.

POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin01/major-upgrade

{
  "delay": false
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task flow ID.

    Range

    N/A

  • Example normal response
    {
      "job_id": "234asdb34234-54367547-123213"
    }

Status Code

Error Code

For details, see Error Codes.