更新时间:2024-08-20 GMT+08:00
分享

查询实例可升级版本

功能介绍

查询实例可升级版本。

调试

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

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

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

请求参数

无。

响应参数

表2 响应参数

参数

参数类型

描述

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

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

hotfix_upgrade_infos

表6 object

可以升级的热补丁信息。

hotfix_rollback_infos

表7 object

可以回滚的热补丁信息。

表3 upgrade_type_list

参数

参数类型

描述

upgrade_type

String

升级类型。

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

enable

Boolean

升级类型是否可用。

  • true:可用。
  • false:不可用。

upgrade_action_list

Array of 表4 objects

升级操作列表。

is_parallel_upgrade

Boolean

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

  • true:当前实例处于灰度升级的升级待观察升级方式中,已选择了AZ内并行升级方式,后续无法更改。
  • false:当前实例处于升级流程中,未选择AZ内并行升级的方式,后续无法更改。
  • null:当前实例尚未处于升级流程中。
表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描述信息。

表6 hotfix_upgrade_infos

参数

参数类型

描述

version

String

热补丁版本。

common_patch

String

补丁类型。

取值范围:

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

backup_sensitive

Boolean

是否和备份相关。

descripition

String

补丁的描述信息。

表7 hotfix_rollback_infos

参数

参数类型

描述

version

String

热补丁版本。

common_patch

String

补丁类型。

取值范围:

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

backup_sensitive

Boolean

是否和备份相关。

descripition

String

补丁的描述信息。

请求示例

查询实例可升级版本。

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

响应示例

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

{
    "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": "hotfix",
            "upgrade_action_list": null,
            "enable": false,
            "is_parallel_upgrade": null
        },
        {
            "upgrade_type": "inplace",
            "upgrade_action_list": [
                {
                    "upgrade_action": "upgradeAutoCommit",
                    "enable": true
                }
            ],
            "enable": true,
            "is_parallel_upgrade": null
        }
    ],
    "rollback_enabled": false,
    "source_version": "8.102.0",
    "target_version": null,
    "roll_upgrade_progress": {
        "not_fully_upgraded_az": "cn-southwest-244a,cn-southwest-244b,cn-southwest-244c",
        "already_upgraded_az": "",
        "az_description_map": {
            "cn-southwest-244c": "az3",
            "cn-southwest-244b": "az2",
            "cn-southwest-244a": "az1"
        }
    },
    "upgrade_candidate_versions": [
        "8.300.0",
        "8.103.0"
    ],
    "hotfix_upgrade_candidate_versions": [],
    "hotfix_rollback_candidate_versions": [],
    "hotfix_upgrade_infos": [],
    "hotfix_rollback_infos": []
}

状态码

错误码

请参见错误码

相关文档