Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Management/ Modifying Database Remarks
Updated on 2023-10-18 GMT+08:00
View PDF

Modifying Database Remarks

Function

This API is used to modify database remarks of a GaussDB(for MySQL) instance. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

databases

Yes

Array of Table 4 objects

List of databases that you want to change the remarks for. The list contains up to 50 databases.
Table 4 UpdateDatabaseComment

Parameter

Mandatory

Type

Description

name

Yes

String

Database name.

comment

Yes

String

Database remarks.

Value:

The value can consist of up to 512 characters, and cannot contain the carriage return characters or special characters (!<"='>&).

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

ID of the task for changing database remarks.

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 database remarks

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