文档首页> 云数据库 GaussDB> API参考> API（推荐）> 版本升级> 查询批量实例可升级的版本和升级类型
更新时间：2024-07-12 GMT+08:00
查看PDF

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

功能介绍

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

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

最小长度：32

最大长度：100

请求参数

表2 请求参数

参数

是否必选

参数类型

描述

instance_ids

否

Array of strings

批量实例ID。

响应参数

表3 响应参数

参数

参数类型

描述

upgrade_type_list

Array of 表4 objects

升级类型信息列表。

数组长度：0 - 1000

target_version

String

升级目标版本，没有在滚动升级中返回null。

最小长度：0

最大长度：1000

upgrade_candidate_versions

Array of strings

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

最小长度：0

最大长度：1000

数组长度：0 - 1000

hotfix_upgrade_infos

Array of 表6 objects

可以升级的热补丁信息。

数组长度：0 - 1000
表4 UpgradeTypeInfo

参数

参数类型

描述

upgrade_type

String

升级类型。grey=灰度升级，inplace=就地升级，hotfix=热补丁升级。

最小长度：0

最大长度：1000

枚举值：

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

参数

参数类型

描述

upgrade_action

String

升级操作。upgrade=升级，upgradeAutoCommit=升级自动提交，commit=提交，rollback=回滚。

最小长度：0

最大长度：1000

枚举值：

  • upgrade
  • upgradeAutoCommit
  • commit
  • rollback

enable

Boolean

升级类型是否可用。

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

参数

参数类型

描述

version

String

热补丁版本。

common_patch

String

通用/非通用信息。common=通用补丁，certain=定制补丁。

枚举值：

  • common
  • certain

backup_sensitive

Boolean

是否和备份相关。

descripition

String

补丁的描述信息。

请求示例

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

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

响应示例

当前批量实例只支持就地升级。

{ 
  "upgrade_type_list" : [ { 
    "upgrade_type" : "inplace", 
    "enable" : true, 
    "upgrade_action_list" : [ { 
      "upgrade_action" : "upgradeAutoCommit", 
      "enable" : true 
    } ] 
  }, { 
    "upgrade_type" : "grey", 
    "enable" : false 
  } ], 
  "upgrade_candidate_versions" : [ "8.100.0", "8.101.0" ] 
}

状态码

错误码

请参见错误码。

父主题： 版本升级