文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 创建StarRocks数据库账号- CreateStarRocksDatabaseUser
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建StarRocks数据库账号 - CreateStarRocksDatabaseUser

功能介绍

创建StarRocks数据库账号。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:createUser

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:user:create

    -

URI

POST /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 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

user_name

是

String

参数解释：

数据库账户名。

约束限制：

长度为2-32个字符，必须以小写字母开头，小写字母或数字结尾，可以包含小写字母、数字以及下划线，不能包含其它特殊字符。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

账户密码。

约束限制：

  • 8-32个字符

  • 不能与用户名或倒序的用户名相同

  • 至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符~！@#%^*-_=+?,

取值范围：

不涉及。

默认取值：

不涉及。

databases

是

Array of strings

参数解释：

数据库列表。

约束限制：

必填。

取值范围：

不涉及。

默认取值：

不涉及。

dml

否

Integer

参数解释：

DML权限。

约束限制：

不涉及。

取值范围：

  • 0：读写权限。

  • 1：只读权限。

  • 2：只读和设置权限。

  • 3：读写和设置权限。

默认取值：

2。

ddl

否

Integer

参数解释：

DDL权限。

约束限制：

不涉及。

取值范围：

  • 0：无DDL权限。

  • 1：有DDL权限。

默认取值：

0。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求结果。

取值范围：

不涉及。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

创建数据库账号。

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

{
  "user_name" : "user_test",
  "dml" : 2,
  "ddl" : 0,
  "password" : "Rds_1234",
  "databases" : [ "INFORMATION_SCHEMA", "default" ]
}

响应示例

状态码： 200

Success.

{
  "result" : "SUCCESS"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版