Modifying the Database Remarks of a Specified DB Instance

Function

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

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:database:update	write	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	rds:database:create	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:database:update

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:database:create

Constraints

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 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 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: 5.6.51.3 or later.
- RDS for MySQL 5.7: 5.7.33.1 or later.
- RDS for MySQL 8.0: 8.0.25.1 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
POST /v3/{project_id}/instances/{instance_id}/database/update

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

Request

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Specifies the database name. Constraints N/A Range You can obtain the value of this parameter from name in Table 3 by calling the API for querying databases. Default Value N/A
comment	No	String	Definition Specifies the new database remarks. Constraints N/A Range The value can contain 0 to 512 characters. Default Value N/A

Example Request

Modify the database remarks of a DB instance.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/database/update

{
    "name": "rds",
    "comment": "this is a comment"
}