Updated on 2026-09-22 GMT+08:00

Creating a Database Account

Function

This API is used to create a database account for a GeminiDB Redis instance.

Constraints

Only the GeminiDB Redis API is supported.
This operation cannot be performed when the instance is in any of the following states: creating, changing specifications, changing database port, frozen, or abnormal.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
users	No	Array of Table 4 objects	Definition All accounts to be created. Constraints N/A

**Table 4** UserForCreation
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Account name. Constraints The value cannot be empty. It must start with a letter and contain up to 36 characters, including only digits, letters, hyphens (-), and underscores (_). Range N/A Default Value N/A
password	Yes	String	Definition Password. Constraints The password can contain 8 to 32 characters. The password must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are allowed: ~ ! @ # % ^ * - _ = +? $ () & Range N/A Default Value N/A
databases	Yes	Array of strings	Definition All databases that the account has access permissions for. Constraints At least one database must be specified, or you can set this parameter to all to select all databases.
privilege	Yes	String	Definition Account permission. Constraints N/A Range ReadOnly: The account has the read-only permission. ReadWrite: The account has the read and write permissions. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

Example Requests

Creating 2 database accounts (Set name of the first account to redis1, password to ****, privilege to ReadOnly, and databases to [ "1", "2" ].)

POST https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/054e292c9880d4992f02c0196d3ein12/db-users

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

Example Responses

Status code: 200

Success

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Managing Databases and Accounts