文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 管理数据库和账号/ 创建数据库账号 - CreatingaDatabaseAccount
更新时间：2026-05-28 GMT+08:00
查看PDF
分享

创建数据库账号 - CreatingaDatabaseAccount

功能介绍

在Redis实例中创建数据库账号。

接口约束

  • 只支持GeminiDB Redis接口。
  • 实例在创建、变更规格、修改端口、异常状态或冻结状态下不能执行该操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:createDatabaseUser

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:createDatabaseUser

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用7.3.1 创建实例接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

users

否

Array of 表4 objects

参数解释：

需要创建的账号列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 UserForCreation

参数

是否必选

参数类型

描述

name

是

String

参数解释：

账号名称。

约束限制：

不能为空，长度不超过36个字符，以字母开头，仅包含数字、字母、中划线、下划线。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

密码。

约束限制：

  • 密码长度为8~32位。
  • 密码需包含大写字母、小写字母、数字和特殊字符中的至少两种，支持的特殊字符为~ ! @ # / %^ * - _ = +? $ () &。

取值范围：

不涉及。

默认取值：

不涉及。

databases

是

Array of strings

参数解释：

账号授权的数据库名称列表。

约束限制：

至少指定一个数据库，或指定"all"来选择所有数据库。

取值范围：

不涉及。

默认取值：

不涉及。

privilege

是

String

参数解释：

账号权限。

约束限制：

不涉及。

取值范围：

  • ReadOnly：账号为只读权限；
  • ReadWrite：账号为读写权限。

默认取值：

不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。

请求示例

创建2个数据库账号。第一个账号名为“redis1”，密码为"****"，权限为只读，数据库名称列表为[ "1", "2" ] 
POST https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/054e292c9880d4992f02c0196d3ein12/db-users

{ 
  "users" : [ { 
    "name" : "redis1", 
    "password" : "****", 
    "privilege" : "ReadOnly", 
    "databases" : [ "1", "2" ] 
  }, { 
    "name" : "redis2", 
    "password" : "****", 
    "privilege" : "ReadOnly", 
    "databases" : [ "1", "2" ] 
  } ] 
}

响应示例

状态码： 200

Success.

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

状态码

请参见状态码。

错误码

请参见错误码。

相关文档