Help Center/ Relational Database Service/ API Reference/ API v3/ Querying Minor Versions Available for Instance Upgrade (RDS for PostgreSQL)
Updated on 2026-09-20 GMT+08:00

Querying Minor Versions Available for Instance Upgrade (RDS for PostgreSQL)

Function

This API is used to query minor versions.

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:listDatabaseVersion

-

database

-

rds:instance:list

-

URI

  • URI format

    GET /v3/{project_id}/datastores/{database_name}/small-version?version={version_name}

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    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

    database_name

    Yes

    String

    Definition

    DB engine name.

    Constraints

    N/A

    Range

    postgresql

    Default Value

    N/A

    version

    Yes

    String

    Definition

    DB engine version. You can enter a major or minor version number.

    Constraints

    N/A

    Range

    For example, 16, 16.5, or 16.5.21

    Default Value

    N/A

    offset

    No

    Integer

    Definition

    Index offset. The query starts from the next piece of data indexed by this parameter.

    Constraints

    The value must be a non-negative number.

    Range

    An integer greater than or equal to 0

    Default Value

    0

    limit

    No

    Integer

    Definition

    Number of records returned by a query.

    Constraints

    N/A

    Range

    The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.

    Default Value

    100

Request

None

Example Request

Query the minor versions of RDS for PostgreSQL 16.
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/datastores/postgresql/small-version?version=16

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    data_stores

    Array of objects

    Definition

    List of available DB engine versions to which an instance can be upgraded. For details, see Table 3.

    count

    int

    Definition

    Total number of query results.

    Range

    N/A

    Table 3 data_stores field description

    Parameter

    Type

    Description

    id

    String

    Definition

    DB engine version ID. The value is unique.

    Range

    N/A

    name

    String

    Definition

    Available minor version number.

    Range

    N/A

    favored

    Boolean

    Definition

    Whether the version is a recommended version.

    Range

    • true: The version is a recommended version.
    • false: The version is not a recommended version.
  • Example normal response
    {
      "count": 3,
      "dataStores": [
        {
          "id": "87620726-6802-46c0-9028-a8785e1f1921",
          "name": "16.5.21",
          "favored": true
        },
        {
          "id": "87620726-6802-46c0-9028-a8785e1f1922",
          "name": "16.8.33",
          "favored": false
        },
        {
          "id": "e8a8b8cc-63f8-4fb5-8d4a-24c502317a62",
          "name": "16.17.51",
          "favored": false
        }
      ]
    }
  • Abnormal response

    For details, see Abnormal Response Results.

Status Code

Error Code

For details, see Error Codes.