Changing Password of a Database User
Function
This API is used to change the password of a database user. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/db-users/password
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: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A |
instance_id |
Yes |
String |
Definition: Instance ID, which uniquely identifies an instance. Constraints: N/A Range: The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: N/A Range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Request language type. Constraints: N/A Range: Default value: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
users |
Yes |
Array of ResetDatabasePassword objects |
Definition: List of database users whose passwords are to be changed. Constraints: The list can contain a maximum of 50 database users. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition: Database username. Constraints: N/A Range: The username can consist of 1 to 32 characters. Only letters, digits, and underscores (_) are allowed. Default value: N/A |
host |
Yes |
String |
Definition: Host IP address. Constraints: To specify multiple IP addresses, separate them with commas (,), for example, 192.168.0.1,172.16.213.9 (no spaces before or after the comma). Range: %: All IP addresses can access your TaurusDB instance. You can use % to wildcard some IP addresses. For example, if you enter 10.10.10.%, all IP addresses in the subnet 10.10.10.X can access the TaurusDB instance. Default value: N/A |
password |
Yes |
String |
Definition: Password of the database user. Constraints: You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. Range: The value cannot be empty. It can consist of 8 to 32 characters and must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters |.~!@#$%^*-_=+?,()& Default value: N/A |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition: ID of the task for changing the passwords of database users. Range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Changing password of database user gaussdb_mysql_user1
{ "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "password" : "Rds_1234" } ] }
Example Response
Status code: 202
Success.
{ "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.