Performing a Pre-upgrade Check

Function

This API is used to perform a pre-check before upgrading 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.

Constraints

This API is supported for RDS for MySQL only.

URI

• URI format

  PUT /v3/{project_id}/instances/{instance_id}/upgrade-version/precheck

• 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

Example Request

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin01/upgrade-version/precheck
{
}

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  workflow_id	String	Definition Workflow ID. Range N/A

• Example normal response

  {
    "workflow_id": "234asdb34234-54367547-123213"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.