文档首页/ 云数据库 GaussDB/ API参考/ 历史API/ 版本升级/ 查询批量实例可升级的版本和升级类型
更新时间：2025-10-20 GMT+08:00
查看PDF
分享

查询批量实例可升级的版本和升级类型

功能介绍

查询批量实例可升级的版本和升级类型。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

否

Array of strings

批量实例ID。

响应参数

表3 响应参数

参数

参数类型

描述

upgrade_type_list

Array of 表4 objects

升级类型信息列表。

数组长度：0 - 1000

target_version

String

若实例处于升级待观察中，返回升级的目标版本，否则返回为空。

最小长度：0

最大长度：1000

upgrade_candidate_versions

Array of strings

可以升级的版本，包括大小版本。

最小长度：0

最大长度：1000

数组长度：0 - 1000

hotfix_upgrade_infos

Array of 表6 objects

可以升级的热补丁信息。

数组长度：0 - 1000

hotfix_rollback_infos

Array of 表6 objects

可以回滚的热补丁信息。
表4 upgrade_type_list

参数

参数类型

描述

upgrade_type

String

升级类型。

取值范围：

  • grey：灰度升级。
  • inplace：就地升级。
  • hotfix：热补丁升级。

enable

Boolean

升级类型是否可用。

  • true：可用。
  • false：不可用。

upgrade_action_list

Array of 表5 objects

升级操作列表。

数组长度：0 - 1000

is_parallel_upgrade

Boolean

是否正在进行AZ内并行升级。

  • true：当前实例处于灰度升级的升级待观察升级方式中，已选择了AZ内并行升级方式，后续无法更改。
  • false：当前实例处于升级流程中，未选择AZ内并行升级的方式，后续无法更改。
  • null:当前实例尚未处于升级流程中。
表5 upgrade_action_list

参数

参数类型

描述

upgrade_action

String

升级操作。

取值范围：

  • upgrade：升级。
  • upgradeAutoCommit：升级自动提交。
  • commit：提交。
  • rollback：回滚。

enable

Boolean

升级类型是否可用。

  • true：可用。
  • false：不可用。
表6 hotfix_upgrade_infos

参数

参数类型

描述

version

String

热补丁版本。

common_patch

String

补丁类型。

取值范围：

  • common：通用补丁。
  • certain：定制补丁。

backup_sensitive

Boolean

是否和备份相关。

取值范围：

  • true：和备份相关。
  • false：和备份不相关。

descripition

String

补丁的描述信息。

请求示例

查询批量实例可升级的版本和升级类型。

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

响应示例

查询批量实例可升级的版本和升级类型。

{
    "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": [
        "8.302.90"
    ],
    "target_version": null,
    "hotfix_upgrade_infos": [],
    "hotfix_rollback_infos": []
}

状态码

错误码

请参见错误码。

父主题： 版本升级