Help Center/ Relational Database Service/ API Reference/ Historical APIs/ API v3/ Upgrading a Minor Version
Updated on 2024-04-01 GMT+08:00
View PDF
Share

Upgrading a Minor Version

Function

This API is used to upgrade minor versions of RDS for MySQL or RDS for PostgreSQL instances.

This API will be unavailable on September 14, 2025. You are advised to switch workloads to the new API (Upgrading the Minor Version of a DB Instance) before then.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

This API is supported for MySQL and PostgreSQL DB engines.

The constraints on minor version upgrades for RDS for PostgreSQL are as follows:
  • The minor version cannot be upgraded for instances with abnormal nodes.
  • The following minor versions cannot be upgraded:

    - Versions earlier than 11.2 for RDS for PostgreSQL 11

    - The upgrade will be performed immediately upon the submission of your request. Delayed upgrade of minor versions is not supported.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/action/db-upgrade

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

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

    instance_id

    Yes

    Instance ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

delay

No

Boolean

Whether to delay the upgrade until the maintenance window.

  • true: Delay the upgrade. The instance will be upgraded during the specified maintenance window.
  • false: Upgrade the instance immediately (default value).

Example Request

Upgrading the minor version of a DB instance

POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/db-upgrade

{
    "delay":false
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

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

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: API v3