Updated on 2026-01-06 GMT+08:00

Modifying the Database Remarks of a Specified DB Instance

Function

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

Constraints

  • This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.
  • The remarks will be deleted if its value is changed to an empty string or null.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/database/update

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

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Database name.

comment

No

String

Database remarks.

The value can contain 1 to 512 characters.

Example Request

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

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

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

Error Code

For details, see Error Codes.