Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Upgrading Minor Versions of Instances in Batches
Updated on 2025-09-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Upgrading Minor Versions of Instances in Batches

Function

This API is used to upgrade minor versions of instances in batches. Before calling this API:

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/instances/database-version/upgrade

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

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

databases_instance_infos

Yes

Array of UpgradeDatabasesSingleInstance objects

Definition

Instances to be upgraded in batches.

Constraints

N/A

delay

Yes

String

Definition

Whether to delay the upgrade.

Constraints

N/A

Range

  • true: The upgrade will be delayed.

  • false: The upgrade will not be delayed.

Default Value

N/A
Table 4 UpgradeDatabasesSingleInstance

Parameter

Mandatory

Type

Description

current_version

Yes

String

Definition

Current kernel version of the instance.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

resp

String

Definition

API calling results.

Range

N/A

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

Upgrading minor versions of instances in batches

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/database-version/upgrade

{
  "databases_instance_infos" : [ {
    "current_version" : "2.0.48.231200",
    "instance_id" : "6754902da1f447269c6979b0590102a5in07"
  } ],
  "delay" : false
}

Example Response

Status code: 200

Success.

{
  "resp" : "success"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management