Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Upgrading the Kernel Version of a Proxy Instance
Updated on 2025-09-04 GMT+08:00

Upgrading the Kernel Version of a Proxy Instance

Function

This API is used to upgrade the kernel version of a proxy instance. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/upgrade-version

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

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

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

Default Value

N/A

proxy_id

Yes

String

Definition

Proxy instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of po01. 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

source_version

Yes

String

Definition

Source kernel version.

Constraints

N/A

Range

N/A

Default Value

N/A

target_version

Yes

String

Definition

Target kernel version.

Constraints

The target kernel version must be later than or equal to the source kernel version.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

update_result

Array of ProxyUpgradeVersionDetail objects

Definition

Proxy instance upgrade information.

Table 5 ProxyUpgradeVersionDetail

Parameter

Type

Description

instance_id

String

Definition

Proxy instance ID.

Range

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

workflow_id

String

Definition

Workflow ID.

Range

N/A

state

String

Definition

Returned status.

Range

  • ACCEPT: The task is accepted.

  • REJECT: The task is rejected.

error_message

String

Definition

Error message.

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 the kernel version of a proxy instance

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/517ea793ab91438cbfcd9c4b1c958b1ein07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/upgrade-version

{
  "source_version" : "2.23.12.000",
  "target_version" : "2.24.03.000"
}

Example Response

Status code: 200

Success.

{
  "update_result" : [ {
    "workflow_id" : "375ac6a4-2788-4e45-83bf-8a9d2324317f",
    "state" : "ACCEPT",
    "error_message" : null
  }, {
    "workflow_id" : "375ac6a4-2788-4e45-83be-8a9d2324327f",
    "state" : "REJECT",
    "error_message" : "Upgrade failed due to insufficient subnet ip"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.