文档首页/ 云数据库 TaurusDB/ API参考/ API/ 实例管理/ 查询实例升级预检查结果 - ShowKernelUpgradeCheckResult
更新时间：2026-09-08 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"
  } ]
}

SDK代码示例

SDK代码示例如下。

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ShowKernelUpgradeCheckResultSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKernelUpgradeCheckResultRequest request = new ShowKernelUpgradeCheckResultRequest();
        UpgradePrecheckRequest body = new UpgradePrecheckRequest();
        List<PreCheckForUpgradeDatabasesSingleInstance> listbodyDatabasesInstanceInfos = new ArrayList<>();
        listbodyDatabasesInstanceInfos.add(
            new PreCheckForUpgradeDatabasesSingleInstance()
                .withCurrentVersion("2.0.72.251200")
                .withInstanceId("20a222abbe61464b868d5c481da456b3in07")
        );
        body.withDatabasesInstanceInfos(listbodyDatabasesInstanceInfos);
        request.withBody(body);
        try {
            ShowKernelUpgradeCheckResultResponse response = client.showKernelUpgradeCheckResult(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ShowKernelUpgradeCheckResultSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKernelUpgradeCheckResultRequest request = new ShowKernelUpgradeCheckResultRequest();
        UpgradePrecheckRequest body = new UpgradePrecheckRequest();
        List<PreCheckForUpgradeDatabasesSingleInstance> listbodyDatabasesInstanceInfos = new ArrayList<>();
        listbodyDatabasesInstanceInfos.add(
            new PreCheckForUpgradeDatabasesSingleInstance()
                .withCurrentVersion("2.0.72.251200")
                .withInstanceId("20a222abbe61464b868d5c481da456b3in07")
        );
        listbodyDatabasesInstanceInfos.add(
            new PreCheckForUpgradeDatabasesSingleInstance()
                .withCurrentVersion("2.0.72.251200")
                .withInstanceId("e24d89b4ef424cbd80b5971bdfcebad1in07")
        );
        body.withDatabasesInstanceInfos(listbodyDatabasesInstanceInfos);
        request.withBody(body);
        try {
            ShowKernelUpgradeCheckResultResponse response = client.showKernelUpgradeCheckResult(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKernelUpgradeCheckResultRequest()
        listDatabasesInstanceInfosbody = [
            PreCheckForUpgradeDatabasesSingleInstance(
                current_version="2.0.72.251200",
                instance_id="20a222abbe61464b868d5c481da456b3in07"
            )
        ]
        request.body = UpgradePrecheckRequest(
            databases_instance_infos=listDatabasesInstanceInfosbody
        )
        response = client.show_kernel_upgrade_check_result(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKernelUpgradeCheckResultRequest()
        listDatabasesInstanceInfosbody = [
            PreCheckForUpgradeDatabasesSingleInstance(
                current_version="2.0.72.251200",
                instance_id="20a222abbe61464b868d5c481da456b3in07"
            ),
            PreCheckForUpgradeDatabasesSingleInstance(
                current_version="2.0.72.251200",
                instance_id="e24d89b4ef424cbd80b5971bdfcebad1in07"
            )
        ]
        request.body = UpgradePrecheckRequest(
            databases_instance_infos=listDatabasesInstanceInfosbody
        )
        response = client.show_kernel_upgrade_check_result(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.ShowKernelUpgradeCheckResultRequest{}
	var listDatabasesInstanceInfosbody = []model.PreCheckForUpgradeDatabasesSingleInstance{
        {
            CurrentVersion: "2.0.72.251200",
            InstanceId: "20a222abbe61464b868d5c481da456b3in07",
        },
    }
	request.Body = &model.UpgradePrecheckRequest{
		DatabasesInstanceInfos: listDatabasesInstanceInfosbody,
	}
	response, err := client.ShowKernelUpgradeCheckResult(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.ShowKernelUpgradeCheckResultRequest{}
	var listDatabasesInstanceInfosbody = []model.PreCheckForUpgradeDatabasesSingleInstance{
        {
            CurrentVersion: "2.0.72.251200",
            InstanceId: "20a222abbe61464b868d5c481da456b3in07",
        },
        {
            CurrentVersion: "2.0.72.251200",
            InstanceId: "e24d89b4ef424cbd80b5971bdfcebad1in07",
        },
    }
	request.Body = &model.UpgradePrecheckRequest{
		DatabasesInstanceInfos: listDatabasesInstanceInfosbody,
	}
	response, err := client.ShowKernelUpgradeCheckResult(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理

相关文档