文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 数据库管理/ 修改数据库备注- UpdateGaussMySqlDatabaseComment
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改数据库备注 - UpdateGaussMySqlDatabaseComment

功能介绍

修改云数据库 TaurusDB实例数据库备注。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:database:modify

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:database:modify

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

databases

是

Array of 表4 objects

参数解释：

准备修改备注的数据库列表。

约束限制：

列表最大长度为50。
表4 UpdateDatabaseComment

参数

是否必选

参数类型

描述

name

是

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

数据库名称长度可在1～64个字符之间，由字母、数字、下划线、中划线组成，中划线的累计总长度小于等于10个字符，且不能包含其他特殊字符。

默认取值：

不涉及。

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库管理