Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Resetting the Administrator Password of an Instance
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Resetting the Administrator Password of an Instance

Function

This API is used to reset the administrator password of an instance.

Constraints

This API supports the following instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

This operation cannot be performed on frozen or abnormal instances.

Only the password of user rwuser can be reset.

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

    Write

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

    nosql:instance:modifyPasswd

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/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

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

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.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

password

Yes

String

Definition

Database password.

Constraints

The value can contain 8 to 32 characters. It must be a combination of at least two of the following types: uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters ~!@#%^*-_=+?$()&

The password of GeminiDB Redis instances can contain at least two of the following types: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^&*()-_=+?

Enter a strong password against security risks such as brute force cracking.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

No response parameters

Example Requests

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password
  • Resetting the administrator password of an instance to ****** 
    {
  "password" : "******"
}

Example Responses

Status code: 204

No Content

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances