Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Version Upgrade/ Querying Upgrade Types and Versions That Instances Can Be Upgraded to in Batches

Updated on 2025-08-11 GMT+08:00

View PDF

Querying Upgrade Types and Versions That Instances Can Be Upgraded to in Batches

Function

This API is used to query the available upgrade types and versions that instances can be upgraded to in batches. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

POST /v3.1/{project_id}/instances/db-upgrade/candidate-versions

**Table 1** Parameter description
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 The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
instance_ids	No	Array of strings	Definition Instance IDs for batch upgrade. Constraints N/A

Response Parameters

**Table 3** Response parameters
Parameter	Type	Description
upgrade_type_list	Array of Table 4 objects	Definition Upgrade types. Array length: 0 to 1000
target_version	String	Definition Target version. The target version is only returned when the instance is in the rolling upgrade phase, or no information is returned. Range Minimum length: 0 Maximum characters: 1000
upgrade_candidate_versions	Array of strings	Definition Versions that can be upgraded, including major and minor versions. Minimum length: 0 Maximum characters: 1000 Array length: 0 to 1000
hotfix_upgrade_infos	Array of Table 6 objects	Definition Information about hot patch versions that can be updated. Array length: 0 to 1000
hotfix_rollback_infos	Array of Table 6 objects	Definition Information about hot patch versions that can be rolled back.

**Table 4** upgrade_type_list
Parameter	Type	Description
upgrade_type	String	Definition Upgrade type. Range grey: Gray upgrade inplace: In-place upgrade hotfix: Hot patch update
enable	Boolean	Definition Check if the upgrade type is available. Range true: yes. false: no.
upgrade_action_list	Array of Table 5 objects	Definition Upgrade actions. Array length: 0 to 1000
is_parallel_upgrade	Boolean	Definition Whether intra-AZ parallel upgrade is supported. Range true: The current instance is in the rolling upgrade phase of the gray upgrade. The intra-AZ parallel upgrade is supported. Once this parameter is configured, it cannot be changed later. false: The current instance is being upgraded. The intra-AZ parallel upgrade is not supported. Once this parameter is configured, it cannot be changed later. null: The current instance is not in the upgrade process.

**Table 5** upgrade_action_list
Parameter	Type	Description
upgrade_action	String	Definition Upgrade action. Range upgrade: Upgrade upgradeAutoCommit: Auto-commit commit: Commit rollback: Rollback
enable	Boolean	Definition Check if the upgrade type is available. Range true: yes. false: no.

**Table 6** hotfix_upgrade_infos
Parameter	Type	Description
version	String	Definition Hot patch version. Range N/A
common_patch	String	Definition Patch type. Range common: common patch certain: custom patch
backup_sensitive	Boolean	Definition Whether the patch is related to backups. Range true: The patch is related to backups. false: The patch is not related to backups.
descripition	String	Definition Description of the patch. Range N/A

Example Request

Querying the upgrade types and versions that instances can be upgraded to in batches.

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade/candidate-versions
{ 
  "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ] 
}

Example Response

Querying the available upgrade types and versions that instances can be upgraded to in batches

{
    "upgrade_type_list": [
        {
            "upgrade_type": "grey",
            "upgrade_action_list": [
                {
                    "upgrade_action": "commit",
                    "enable": false
                },
                {
                    "upgrade_action": "rollback",
                    "enable": false
                },
                {
                    "upgrade_action": "upgrade",
                    "enable": true
                },
                {
                    "upgrade_action": "upgradeAutoCommit",
                    "enable": true
                }
            ],
            "enable": true,
            "is_parallel_upgrade": null
        },
        {
            "upgrade_type": "inplace",
            "upgrade_action_list": [
                {
                    "upgrade_action": "upgradeAutoCommit",
                    "enable": true
                }
            ],
            "enable": true,
            "is_parallel_upgrade": null
        },
        {
            "upgrade_type": "hotfix",
            "upgrade_action_list": [
                {
                    "upgrade_action": "upgradeAutoCommit",
                    "enable": false
                },
                {
                    "upgrade_action": "rollback",
                    "enable": false
                }
            ],
            "enable": false,
            "is_parallel_upgrade": null
        }
    ],
    "upgrade_candidate_versions": [
        "V2.0-8.100.0"
    ],
    "target_version": null,
    "hotfix_upgrade_infos": [],
    "hotfix_rollback_infos": []
}