Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Resetting the Administrator Password of an Instance
Updated on 2023-11-21 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 types of instances:

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

This operation cannot be performed on frozen or abnormal instances.

Abnormal instances do not support this operation.

Only the password of user rwuser can be reset.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

password

Yes

String

Database password.

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

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

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