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 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 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 Parameter description

  Name	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	Specifies the DB instance ID.

Request

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"
}

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  resp	String	Returns successful if the invoking is successful.

• Example normal response

  {
      "resp": "successful"
  }

• 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.