Querying Database Accounts

Function

This API is used to query database accounts of a StarRocks instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /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.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
user_name	No	String	Database account.
limit	Yes	Integer	Number of records to be queried. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.
offset	Yes	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
user_details	Array of user_details objects	Database account information.
total_count	Integer	Number of database accounts.

**Table 5** user_details
Parameter	Type	Description
user_name	String	Username of the database account.
data_bases	Array of strings	Authorized databases.
dml	Integer	DML permissions. 0: read/write permissions 1: read-only permissions 2: read-only and configuration permissions 3: read/write and configuration permissions
ddl	Integer	Whether DDL permissions are granted. 0: No 1: Yes

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

Querying 10 database accounts

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users?limit=10

Example Response

Status code: 200

Success.

{
  "user_details" : [ {
    "user_name" : "root",
    "databases" : [ "*" ],
    "dml" : 2,
    "ddl" : 0
  }, {
    "user_name" : "user_test",
    "databases" : [ "*" ],
    "dml" : 2,
    "ddl" : 0
  } ],
  "total_count" : 2
}