Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Enabling Assign Requests to Row and Column Store Nodes for a StarRocks Instance
Updated on 2025-07-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling Assign Requests to Row and Column Store Nodes for a StarRocks Instance

Function

This API is used to enable Assign Requests to Row and Column Store Nodes for a StarRocks instance. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/users/sync

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 in07. 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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

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 parameter

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

StarRocks account synchronization.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

success

String

Definition

Whether Assign Requests to Row and Column Store Nodes is enabled.

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://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/58fab56787854702b20f0e17cdcb49b9in17/starrocks/users/sync

{
  "action" : "startSyncTaurusAccount"
}

Example Response

Status code: 200

Success.

{
  "success" : true
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)