Modifying Remarks of a Database Account

Function

This API is used to modify remarks of a database account for a specified DB instance.

Before calling an API, you need to understand the API in Authentication.

Constraints

To use this function, contact customer service to apply for the required permissions.
This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, or abnormal.
This operation can be performed no matter whether the associated database exists.
- The remarks will be updated or created when this operation is performed, depending on whether the remarks already exist.
- The remarks will be deleted if its value is changed to an empty string or null.
- If the associated database does not exist or is deleted when remarks are created, the remarks will still be saved.

This operation is supported only for specified kernel versions. If your kernel version does not meet the requirements, upgrade the kernel to the latest version by referring to Upgrading a Minor Version.
- RDS for MySQL 5.6: Not supported.
- RDS for MySQL 5.7: Not supported.
- RDS for MySQL 8.0: 8.0.25 or later.
For any database and account created using methods other than the RDS console and APIs, if the database name and account name do not meet the database naming rules (see Table 2) and account naming rules (see Table 2), for example, containing Chinese characters or unsupported special characters, the database and account cannot be managed through the RDS console or APIs.
In migration scenarios, if any database name and account name of the source database do not meet the database naming rules (see Table 2) and account naming rules (see Table 2), the database and account cannot be managed through the RDS console or APIs after being migrated to the destination RDS for MySQL database.

URI

URI format
PUT /v3/{project_id}/instances/{instance_id}/db-users/{user_name}/comment

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Instance ID.
user_name	Yes	Database username.

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
comment	No	String	Remarks of the database username. Value range: 1 to 512 characters.

Example Request

Modify the remarks of user root for a DB instance.

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db-users/root/comment

{
    "comment": "this is a comment"
}