文档首页/ 云数据库 TaurusDB/ API参考/ API/ 实例管理/ 查询实例升级预检查结果 - ShowKernelUpgradeCheckResult
更新时间：2026-08-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例升级预检查结果 - ShowKernelUpgradeCheckResult

功能介绍

查询实例升级预检查结果。

接口约束

  • 单次最多支持100个实例进行升级预检查。

  • 批量升级预检查时，所有实例的源版本需保持一致。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:upgrade

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:upgrade

    -

URI

POST /v3/{project_id}/instances/database-version/upgrade/pre-check-result

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

databases_instance_infos

是

Array of UpgradeDatabasesSingleInstance objects

参数解释：

升级预检查实例信息。

约束限制：

不涉及。
表4 UpgradeDatabasesSingleInstance

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

current_version

是

String

参数解释：

实例当前的内核版本。可通过调用查询内核版本信息接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

upgrade_precheck_result

String

参数解释：

预检查结果。

取值范围：

  • true：成功。

  • false：失败。

updated_at

Long

参数解释：

预检查完成时间。

取值范围：

格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区。

upgrade_precheck_detail

Array of UpgradeDatabasePrecheckResult objects

参数解释：

实例预检查详情。
表6 UpgradeDatabasePrecheckResult

参数

参数类型

描述

check_item

String

参数解释：

升级预检查项目。

取值范围：

  • Upgrade permission check：升级权限检查。

  • Instance version check：实例源版本检查。

  • Resource check：资源检查。

  • Upgrade feature compatibility check：升级特性兼容性检查。

check_description

String

参数解释：

升级预检查项说明。

取值范围：

不涉及。

check_object

String

参数解释：

升级预检查对象。

取值范围：

不涉及。

check_status

String

参数解释：

升级预检查项的检查状态。

取值范围：

  • passed：检查通过。

  • failed：检查失败。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 查询单个实例的升级预检查结果。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/database-version/upgrade/pre-check-result

{
  "databases_instance_infos" : [ {
    "instance_id" : "20a222abbe61464b868d5c481da456b3in07",
    "current_version" : "2.0.72.251200"
  } ]
}

  • 查询多个实例的升级预检查结果。

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/database-version/upgrade/pre-check-result

{
  "databases_instance_infos" : [ {
    "instance_id" : "20a222abbe61464b868d5c481da456b3in07",
    "current_version" : "2.0.72.251200"
  }, {
    "instance_id" : "e24d89b4ef424cbd80b5971bdfcebad1in07",
    "current_version" : "2.0.72.251200"
  } ]
}

响应示例

状态码：200

Success.

{
  "upgrade_precheck_result" : "false",
  "updated_at" : 1775802349268,
  "upgrade_precheck_detail" : [ {
    "check_item" : "Upgrade permission check",
    "check_description" : "The operation not supported. Contact the administrator please.",
    "check_status" : "failed",
    "check_object" : "user permission"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理

相关文档