Help Center/ TaurusDB/ API Reference/ APIs/ Instance Management/ Querying Upgrade Pre-check Results of Instances
Updated on 2026-08-31 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Upgrade Pre-check Results of Instances

Function

This API is used to query upgrade pre-check results of instances. Before calling this API:

Constraints

  • A maximum of 100 instances can be pre-checked for upgrade at a time.

  • During a batch upgrade pre-check, the source versions of all instances must be the same.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English

  • zh-cn: Chinese

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

databases_instance_infos

Yes

Array of UpgradeDatabasesSingleInstance objects

Definition

Information about the instances to be checked before the upgrade.

Constraints

N/A
Table 4 UpgradeDatabasesSingleInstance

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

To obtain this value, see Querying DB Instances.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

current_version

Yes

String

Definition

Current kernel version of the instance. You can obtain the value by calling the API for querying the kernel version.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

upgrade_precheck_result

String

Definition

Pre-check result.

Range

  • true: successful

  • false: failed

updated_at

Long

Definition

Pre-check completion time.

Range

The value is a Unix timestamp in milliseconds and represents UTC time.

upgrade_precheck_detail

Array of UpgradeDatabasePrecheckResult objects

Definition

Instance pre-check details.
Table 6 UpgradeDatabasePrecheckResult

Parameter

Type

Description

check_item

String

Definition

Upgrade pre-check item.

Range

  • Upgrade permission check: upgrade permission check

  • Instance version check: source version check

  • Resource check: resource check

  • Upgrade feature compatibility check: upgrade feature compatibility check

check_description

String

Definition

Description of the upgrade pre-check item.

Range

N/A

check_object

String

Definition

Upgrade pre-check object.

Range

N/A

check_status

String

Definition

Check status of the upgrade pre-check item.

Range

  • passed: The check is passed.

  • failed: The check failed.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Querying the upgrade pre-check result of a single instance

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

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

  • Querying the upgrade pre-check results of multiple instances

    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"
  } ]
}

Example Response

Status code: 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"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Instance Management