更新时间:2025-07-29 GMT+08:00

查询StarRocks数据库账号

功能介绍

查询StarRocks数据库账户。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

StarRocks实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

user_name

String

参数解释

数据库账户。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

limit

Integer

参数解释

查询记录数。

约束限制

不涉及。

取值范围

1-100。

默认取值

1。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

约束限制

不涉及。

取值范围

≥0。

默认取值

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

user_details

Array of user_details objects

参数解释

数据库账户信息。

取值范围

不涉及。

total_count

Integer

参数解释

数据库账户数量。

取值范围

不涉及。

表5 user_details

参数

参数类型

描述

user_name

String

参数解释

数据库账户名。

取值范围

不涉及。

data_bases

Array of strings

参数解释

已授权数据库。

取值范围

不涉及。

dml

Integer

参数解释

DML授权。

取值范围

  • 0:读写权限

  • 1:只读权限

  • 2:只读和设置权限

  • 3:读写和设置权限

ddl

Integer

参数解释

DDL授权。

取值范围

  • 0:无DDL权限

  • 1:有DDL权限

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询数据库10个账号信息。

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

响应示例

状态码: 200

Success.

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

状态码

请参见状态码

错误码

请参见错误码