文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 版本升级/ 批量实例内核版本定时升级 - UpgradingKernelVersionofInstancesasScheduledinBatches
更新时间:2026-07-16 GMT+08:00

批量实例内核版本定时升级 - UpgradingKernelVersionofInstancesasScheduledinBatches

功能介绍

GaussDB批量实例版本定时升级。当前只允许热补丁升级,且仅支持升级自动提交,中间无业务中断,仅用于修复产品BUG。

调试

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

URI

POST /v3/{project_id}/instances/db-upgrade/schedule-task

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

指定接口返回信息的语言类型。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文
  • en-us:英文

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

Array of strings

参数解释:

批量实例ID。获取方式请参考查询数据库实例列表 - QueryingDBInstances

约束限制:

不涉及。

start_time

String

参数解释:

任务开始时间。

约束限制:

格式为"YYYY-MM-DDTHH:mm:ss"。

取值范围:

不涉及。

默认取值:

不涉及。

upgrade_type

String

参数解释:

实例升级类型。

约束限制:

区分大小写。

取值范围:

hotfix:热补丁升级。

默认取值:

不涉及。

upgrade_action

String

参数解释:

实例升级操作。

约束限制:

热补丁升级目前只包括升级自动提交。

取值范围:

upgradeAutoCommit:升级自动提交。

默认取值:

不涉及。

target_version

String

参数解释:

批量实例升级目标版本。获取方法请参考查询批量实例可升级的版本和升级类型 - QueryingUpgradeTypesandVersionsThat InstancesCanBeUpgradedtoinBatches

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

表4 响应参数

参数

参数类型

描述

instance_tasks

Array of 表5 objects

参数解释:

任务详情。

表5 InstanceTaskDetail

参数

参数类型

描述

task_id

String

参数解释:

任务ID。

取值范围:

不涉及。

task_name

String

参数解释:

任务名称。

取值范围:

不涉及。

instance_id

String

参数解释:

实例ID。

取值范围:

不涉及。

请求示例

批量实例热补丁升级并采用升级自动提交方式升级传参。
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade/schedule-task
{ 
  "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], 
  "start_time": "2023-06-06T01:47:20+0800",
  "upgrade_type" : "hotfix", 
  "upgrade_action" : "upgradeAutoCommit" ,
  "target_version" : "3.208.0.6,3.208.0.7" 
}

响应示例

{
    "instance_tasks": [
        {
            "task_id": "07c5880a-cbf0-44ad-91c1-5803a10f11a1",
            "task_name": "HOTFIX_VERSION_UPGRADE",
            "instance_id": "cc0ae5c47bf94834bf9e44138f7f995ain14"
        },
        {
            "task_id": "07c5880a-cbf0-44ad-91c1-5803a10f11a1",
            "task_name": "HOTFIX_VERSION_UPGRADE",
            "instance_id": "aa0ae5c47bf94834bf9e44138f7f995ain14"
        }
    ]
}

状态码

错误码

请参见错误码