Updated on 2026-08-31 GMT+08:00

Performing an Instance Upgrade Pre-check

Function

This API is used to perform an instance upgrade pre-check. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

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 role/policy-based authorization, see Permissions and Supported Actions for details on 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

**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
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
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

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_ids	Array of strings	Definition Pre-check task ID set.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Performing an upgrade pre-check for a single instance

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

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

Performing an upgrade pre-check for multiple instances

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

{
  "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.

{
  "job_ids" : [ "12edd063-bce6-4780-88c1-aadd094046e8", "12edd063-bce6-4780-88c1-abdd094046e8" ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Instance Management