Help Center/ GeminiDB/ API Reference/ API v3/ Managing Databases and Accounts/ Resetting the Password of a Database Account
Updated on 2026-09-22 GMT+08:00

Resetting the Password of a Database Account

Function

This API is used to reset the password for a GeminiDB Redis database account.

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:resetDbPassword

    Write

    instance *

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

    nosql:instance:resetDatabaseUser

    -

URI

PUT /v3/{project_id}/redis/instances/{instance_id}/db-users/password

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

name

Yes

String

Definition

Account name.

Constraints

The value can contain 1 to 36 characters and must start with a letter. Only digits, letters, hyphens (-), and underscores (_) are allowed.

Range

N/A

Default Value

N/A

password

Yes

String

Definition

Password to be reset.

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

Response Parameters

Status code: 204

No response parameters

Example Requests

Resetting the password of user db_user1
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/redis/instances/3d39c18788b54a919bab633874c159dfin12/db-users/password 

{ 
  "name" : "db_user1", 
  "password" : "********" 
}

Example Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.