文档首页> 云数据库 GaussDB> API参考> API（推荐）> 版本升级> 查询实例可升级版本
更新时间：2024-05-20 GMT+08:00
查看PDF
分享

查询实例可升级版本

功能介绍

查询实例可升级版本。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

无。

响应参数

表2 响应Body参数

参数

参数类型

描述

upgrade_type_list

Array of 表3 objects

升级类型信息列表。

rollback_enabled

Boolean

是否支持回滚。

  • true：支持回滚。
  • false：不支持回滚。

source_version

String

源实例版本号。

target_version

String

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

roll_upgrade_progress

表5 object

升级待观察DN、AZ信息。

upgrade_candidate_versions

Array of strings

可以升级的版本，包括大小版本，升级待观察中返回空数组。

hotfix_upgrade_candidate_versions

Array of strings

可以升级的热补丁版本，滚动升级中返回空数组。

hotfix_rollback_candidate_versions

Array of strings

可以回滚的热补丁版本，滚动升级中返回空数组。
表3 upgrade_type_list

参数

参数类型

描述

upgrade_type

String

升级类型。

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

enable

Boolean

升级类型是否可用。

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

upgrade_action_list

Array of 表4 objects

升级操作列表。
表4 upgrade_action_list

参数

参数类型

描述

upgrade_action

String

升级操作。

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

enable

Boolean

升级操作是否可用。

  • true：可用。
  • false：不可用。
表5 roll_upgrade_progress

参数

参数类型

描述

upgraded_dn_group_numbers

String

已升级分片数。

total_dn_group_numbers

String

总分片数。

not_fully_upgraded_az

String

未完成升级的AZ，以“,”隔开，独立部署返回null。

already_upgraded_az

String

已升级AZ，以“,”隔开，独立部署返回null。

az_description_map

Map<String,String>

AZ描述信息。

请求示例

查询实例可升级版本。

GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/db-upgrade/candidate-versions

响应示例

实例在滚动升级中时，只返回滚动升级目标版本与滚动升级分片和AZ状态。

{ 
  "upgrade_type_list" : [ { 
    "upgrade_type" : "inplace", 
    "enable" : true, 
    "upgrade_action_list" : [ { 
      "upgrade_action" : "upgradeAutoCommit", 
      "enable" : true 
    } ] 
  }, { 
    "upgrade_type" : "grey", 
    "enable" : false
  } ], 
  "rollback_enabled" : true, 
  "target_version" : "3.200.0", 
  "roll_upgrade_progress" : { 
    "upgraded_dn_group_numbers" : null, 
    "total_dn_group_numbers" : null, 
    "not_fully_upgraded_az" : "cn-southwest-244c", 
    "already_upgraded_az" : "cn-southwest-244b,cn-southwest-244a", 
    "az_description_map" : { 
      "az1.dc1" : "可用区1", 
      "az0.dc0" : "az1" 
    } 
  }, 
  "upgrade_candidate_versions" : [ ], 
  "hotfix_upgrade_candidate_versions" : [ ], 
  "hotfix_rollback_candidate_versions" : [ ] 
}

状态码

错误码

请参见错误码。

父主题： 版本升级
分享：

    相关文档

    相关产品