Updated on 2024-08-28 GMT+08:00

Upgrading the Minor Version of a DB Instance

Function

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

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

Constraints

  • This API is available to RDS for MySQL and RDS for PostgreSQL only.
  • The minor versions of any RDS for PostgreSQL instances containing abnormal nodes cannot be upgraded.
  • The minor versions of RDS for PostgreSQL 11 instances earlier than 11.2 cannot be upgraded.
  • For RDS for PostgreSQL, minor versions can be upgraded immediately upon request submission only, but not during the specified maintenance window.
  • A minor version upgrade of RDS for PostgreSQL instances can cause a primary/standby switchover.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    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

Table 2 Parameters

Parameter

Mandatory

Type

Description

is_delayed

No

Boolean

Whether to delay the upgrade until the maintenance window. Valid values:

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

Example Request

Upgrade the minor version of a DB instance.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/db-upgrade 

{
   "is_delayed" : false 
 }

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Task ID.

  • Example normal response
    {
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94" 
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.