文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库管理> 修改数据库备注
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

修改数据库备注

功能介绍

修改云数据库 GaussDB(for MySQL)实例数据库备注。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

databases

是

Array of 表4 objects

修改备注的数据库列表，列表最大长度为50。
表4 UpdateDatabaseComment

参数

是否必选

参数类型

描述

name

是

String

数据库名称。

comment

是

String

数据库备注。

取值范围：

长度不能超过512个字符，不能包含回车和特殊字符!<"='>&。

响应参数

状态码： 202

表5 响应Body参数

参数

参数类型

描述

job_id

String

修改数据库备注的任务ID。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改数据库备注。

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

响应示例

状态码： 202

Success.

{ 
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库管理