Updated on 2026-03-16 GMT+08:00

Modifying the Description of a Database

Function

This API is used to modify the description of a database. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/databases/comment

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
databases	Yes	Array of Table 4 objects	Definition List of databases that you want to modify the description for. Constraints The list can contain a maximum of 50 databases.

**Table 4** UpdateDatabaseComment
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Database name. Constraints N/A Range The database name can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The total number of hyphens (-) cannot exceed 10. Default Value N/A
comment	Yes	String	Definition Database description. Constraints N/A Range The value can consist of up to 512 characters. It cannot contain carriage returns or any of the following special characters: !<"='>& Default Value N/A

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of the task for modifying the description of a database. Range N/A

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 the description of a database

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases/comment 
 
{ 
  "databases" : [ { 
    "name" : "gaussdb_mysql_user1", 
    "comment" : "first_database" 
  } ] 
}

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 Management