Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Upgrading the Kernel Version of a StarRocks Instance
Updated on 2025-09-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Upgrading the Kernel Version of a StarRocks Instance

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/db-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

instance_id

Yes

String

Definition

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

Constraints

N/A

Range

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

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

Yes

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us
  • zh-cn

Default Value

en-us

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

delay

No

String

Definition

Whether to delay the upgrade.

Constraints

N/A

Range

  • true
  • false

Default Value

false

is_skip_validate

No

String

Definition

Whether to skip upgrade verification.

Constraints

N/A

Range

  • true
  • false

Default Value

false

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for upgrading the kernel version.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/db-upgrade

{
  "delay" : false,
  "is_skip_validate" : false
}

Example Response

Status code: 200

Success.

{
  "job_id" : "job_id"
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)