Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Changing Permissions of a Database Account for a StarRocks Instance
Updated on 2025-07-31 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Changing Permissions of a Database Account for a StarRocks Instance

Function

This API is used to change permissions of a database account for a StarRocks instance. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/starrocks/users/permission

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

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

user_name

Yes

String

Definition

Username of the database account.

Constraints

This parameter is mandatory.

Range

N/A

Default Value

N/A

databases

No

Array of strings

Definition

Database list.

Constraints

N/A

Range

N/A

Default Value

N/A

dml

No

Integer

Definition

DML permissions.

Constraints

N/A

Range

  • 0: read/write permission

  • 1: read-only permission

  • 2: read-only and configuration permissions

  • 3: read/write and configuration permissions

Default Value

N/A

ddl

No

Integer

Definition

Whether DDL permissions are granted.

Constraints

N/A

Range

  • 0: No

  • 1: Yes

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

Definition

Request results.

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

Changing permissions of a database account

PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/starrocks/users/permission

{
  "user_name" : "user_test",
  "dml" : 2,
  "databases" : [ "*" ]
}

Example Response

Status code: 200

Success.

{
  "result" : "SUCCESS"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)