Modifying Remarks of a Database User

Function

This API is used to modify the remarks 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/comment

**Table 1** URI 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, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
users	Yes	Array of UpdateDatabaseUserComment objects	List of database users that you want to change the remarks for. The list contains up to 50 database users.

**Table 4** UpdateDatabaseUserComment
Parameter	Mandatory	Type	Description
name	Yes	String	Database username.
host	Yes	String	Host IP address.
comment	Yes	String	Database user remarks. The value can consist of up to 512 characters, and cannot contain the carriage return characters or special characters (!<"='>&). This field is only suitable for instances 2.0.13.0 or later. To upgrade an instance to the latest version, see Upgrading the Kernel Version of a DB Instance.

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for changing the remarks of the database user.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Modifying remarks of a database user

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/comment 

{ 
  "users" : [ { 
    "name" : "gaussdb_mysql_user1", 
    "host" : "127.0.0.1", 
    "comment" : "first_database_user" 
  } ] 
}

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.

Parent topic: Database User Management

Previous topic: Deleting a Database User

Next topic: Changing Password of a Database User

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot