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.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

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:upgradeDatabaseVersion	readwrite	-	-	rds:instance:modify	-

Constraints

This API supports only the upgrade from MySQL 5.7 to MySQL 8.0.
Before using this API, contact customer service to apply for the required permissions.
For detailed constraints, see Upgrading an RDS for MySQL Instance from 5.7 to 8.0.

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"
}

Abnormal response
For details, see Abnormal Request Results.

Status Code

Normal
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Upgrading a Major Version (RDS for MySQL)

Previous topic: Obtaining the Pre-Check Results of an Upgrade from MySQL 5.7 to MySQL 8.0

Next topic: Sessions (RDS for MySQL)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot