Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Creating a Database Account
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Database Account

Function

This API is used to create a database account. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

X-Language

No

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_name

Yes

String

Username of the database account. The username can be 2 to 32 characters long. It must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, and underscores (_) are allowed.

password

Yes

String

Account password. The password must:

  • Consist of 8 to 32 characters.
  • Be different from the username or the username spelled backwards.
  • Contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+?,

databases

Yes

Array of strings

List of databases.

dml

No

Integer

DML permissions. The default value is 2. Values:

  • 0: read/write permission
  • 1: read-only permission
  • 2: read-only and configuration permissions
  • 3: read/write and configuration permissions

ddl

No

Integer

Whether DDL permissions are granted. The default value is 0. Values:

  • 0: No
  • 1: Yes

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

String

Request result.

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

Creating a database account

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users

{
  "userName" : "user_test",
  "dml" : 2,
  "ddl" : 0,
  "passWord" : "Rds_1234",
  "dataBases" : [ "INFORMATION_SCHEMA", "default" ]
}

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)