# 批量实例内核版本定时升级 - UpgradingKernelVersionofInstancesasScheduledinBatches #### 功能介绍 GaussDB批量实例版本定时升级。当前只允许热补丁升级，且仅支持升级自动提交，中间无业务中断，仅用于修复产品BUG。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=CreateScheduleTask)中调试该接口。 #### URI POST /v3/{project_id}/instances/db-upgrade/schedule-task 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_ids | 是 | Array of strings | **参数解释：** 批量实例ID。获取方式请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)。 **约束限制：** 不涉及。 | | start_time | 是 | String | **参数解释：** 任务开始时间。 **约束限制：** 格式为"YYYY-MM-DDTHH:mm:ss"。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | upgrade_type | 是 | String | **参数解释：** 实例升级类型。 **约束限制：** 区分大小写。 **取值范围：** hotfix：热补丁升级。 **默认取值：** 不涉及。 | | upgrade_action | 是 | String | **参数解释：** 实例升级操作。 **约束限制：** 热补丁升级目前只包括升级自动提交。 **取值范围：** upgradeAutoCommit：升级自动提交。 **默认取值：** 不涉及。 | | target_version | 是 | String | **参数解释：** 批量实例升级目标版本。获取方法请参考[查询批量实例可升级的版本和升级类型 - QueryingUpgradeTypesandVersionsThat InstancesCanBeUpgradedtoinBatches](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_329.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 表4响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_tasks | Array of [表5] objects | **参数解释：** 任务详情。 | 表5InstanceTaskDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 | | task_name | String | **参数解释：** 任务名称。 **取值范围：** 不涉及。 | | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | #### 请求示例 批量实例热补丁升级并采用升级自动提交方式升级传参。 ``` POST https://gaussdb-opengauss.cn-north-4.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" } ] } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。