Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Database and Account Management/ Resetting a Password for a Database Account
Updated on 2025-08-11 GMT+08:00

Resetting a Password for a Database Account

Function

This API is used to reset a password for a database account. Before calling this API:

Constraints

  • This operation cannot be performed when the instance is in any of the following statuses: creating, changing instance specifications, frozen, or abnormal.
  • This API can be used to reset the password of only one database account at a time.

URI

PUT /v3/{project_id}/instances/{instance_id}/db-user/password

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Database username.

Constraints

It cannot be system usernames. System users: rdsAdmin, rdsMetric, rdsBackup, and rdsRepl.

Range

N/A

Default Value

N/A

password

Yes

String

Definition

Password of the database account. A strong password helps improve security and mitigate potential threats like brute force attacks.

Constraints

The password cannot be the same as the database username or the database username spelled backwards, and cannot be the same as the original database password.

Range

The value cannot be empty. It must contain 8 to 32 characters, including at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!@#%^*-_=+?,).

Default Value

N/A

Response Parameters

None

Example Request

Resetting the password for database account root
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-user/password
{ 
  "name" : "root", 
  "password" : "*******" 
}

Example Response

None

Status Codes

Error Codes

For details, see Error Codes.