doc-exports/docs/opengauss/api-ref/opengauss_api_0021.html

Resetting a Database Password

Function

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

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

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

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	Yes	DB instance ID.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  password	Yes	String	Password for user root. The password must: Consist of 8 to 32 characters. Contain at least three types of the following characters: Uppercase letters, lowercase letters, digits, and special characters (~! @# %^*-_=+?,) Support weak password verification.

Example Request

Changing the password of user root

{
  "password": "******"
}

Response

• Normal response

  None

• Example normal response

  {}

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management