Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Database and Account Management/ Resetting a Password for a Database Account
Updated on 2024-08-20 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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user/password

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

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

Default value:

None

instance_id

Yes

Instance ID.

Request Parameters

Table 2 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

Username of the database. It cannot be system usernames. System users: rdsAdmin, rdsMetric, rdsBackup, and rdsRepl.

password

Yes

String

Password of the database account.

Value:

The value cannot be empty and contains 8 to 32 characters. It cannot be the same as the name value or the name value in reverse order. It also cannot be the same as the old password. The value must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+?,

Enter a strong password to improve security, preventing security risks such as brute force cracking.

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 Code

Error Code

For details, see Error Codes.