Performing a Major Version Upgrade Pre-Check for a DB Instance (RDS for PostgreSQL)

Function

This API is used to perform a health check before a major version upgrade.

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

Constraints

• This API is available to RDS for PostgreSQL only.
• This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance specifications, changing port, frozen, or abnormal.

URI

• URI format

  POST /v3/{project_id}/instances/{instance_id}/major-version/inspection

• Parameter description

  Table 1 Parameter description

  Name	Type	Mandatory	Description
  project_id	String	Yes	Project ID of a tenant in a region. To obtain it, refer to Obtaining a Project ID.
  instance_id	String	Yes	Instance ID.

Request

• Request parameters

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  target_version	String	Yes	Target version.

• URI example

  https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/inspection
  {
      "target_version": "14.9.0"
  }

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  report_id	String	Check report ID.

• Example normal response

  {
           "report_id": "f7a8e35e-a14c-4e5e-b1f0-d3764e8ed8a8"
  }

• 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.