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

创建数据库用户

功能介绍

创建云数据库 TaurusDB实例数据库用户。

URI

POST /v3/{project_id}/instances/{instance_id}/db-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为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参数

参数

是否必选

参数类型

描述

users

Array of CreateDatabaseUserList objects

参数解释

数据库用户列表。

约束限制

列表最大长度为50。

表4 CreateDatabaseUserList

参数

是否必选

参数类型

描述

name

String

参数解释:

数据库用户名称。

约束限制

不涉及。

取值范围

数据库用户名称在1到32个字符之间,由字母、数字、下划线组成,不能包含其他特殊字符。

默认取值

不涉及。

password

String

参数解释:

数据库用户密码。

约束限制

不能同用户名称相同,非空。建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。

取值范围

至少包含以下字符中的三种:大写字母、小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&组成,长度8~32个字符。

默认取值

不涉及。

comment

String

参数解释:

数据库备注。

约束限制

该字段只针对新版本的实例生效,必须大于等于指定的内核版本-2.0.13.0,如果不符合内核版本要求,参考内核版本升级至最新。

取值范围

长度不能超过512个字符,不能包含回车和特殊字符!<"='>&。

默认取值

不涉及。

hosts

Array of strings

参数解释:

主机IP地址,即允许数据库用户在当前主机连接数据库。

约束限制

一次最多创建50个。

取值范围

%和IP地址,若IP地址为“10.10.10.%”,则表示10.10.10.X的IP地址都可以访问该TaurusDB实例。若您需要添加多个IP地址,请用英文逗号隔开(逗号前后都不能加空格),例如192.168.0.1,172.16.213.9。

默认取值

默认IP地址为%,表示允许所有地址访问TaurusDB实例。

databases

Array of CreateDatabaseList objects

参数解释:

数据库名称列表,即创建数据库用户时同步将列表中的数据库授权给用户。在需要给该用户授权某数据库时,调用授予数据库用户数据库权限接口即可。

约束限制

列表可以为空,列表最大长度为50。

表5 CreateDatabaseList

参数

是否必选

参数类型

描述

name

String

参数解释:

数据库名称。

约束限制

当前已存在的数据库。

取值范围

数据库名称长度可在1~64个字符之间,由字母、数字、下划线、中划线组成,中划线的累计总长度小于等于10个字符,且不能包含其他特殊字符。

默认值

不涉及。

readonly

Boolean

参数解释:

是否为只读权限。

约束限制

不涉及。

取值范围

  • true:表示只读。

  • false:表示可读写。

默认值

不涉及。

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

创建数据库用户的任务ID。

取值范围

符合UUID规则。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

创建数据库用户,读写权限,主机IP地址是127.0.0.1。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users
{
  "users" : [ {
    "name" : "gaussdb_mysql_user1",
    "password" : "Rds_1234",
    "hosts" : [ "127.0.0.1" ],
    "comment" : "database_user_comment", 
    "databases" : [ {
      "name" : "test",
      "readonly" : false
    } ]
  } ]
}

响应示例

状态码: 201

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

状态码

请参见状态码

错误码

请参见错误码