文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 管理数据库和用户（PostgreSQL）/ 修改指定实例的数据库备注 - UpdatePostgresqlDatabase
更新时间：2026-03-16 GMT+08:00
查看PDF
分享

修改指定实例的数据库备注 - UpdatePostgresqlDatabase

功能介绍

修改指定实例中的数据库备注。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:database:update

-

-

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

  • 实例在创建、变更规格、修改端口、异常状态或冻结状态下不能执行该操作。
  • 更新备注为空值，备注将会被删除。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

name

是

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

该参数值可调用查询数据库列表接口，通过表3中的“name”获取。

默认取值：

不涉及。

comment

否

String

参数解释：

数据库备注。

约束限制：

不涉及。

取值范围：

长度可在1~512个字符之间。

默认取值：

不涉及。

请求示例

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database/update
{
    "name": "rds",
    "comment": "this is a comment"
}

响应消息

  • 正常要素说明
    表3 要素说明

    名称

    参数类型

    说明

    resp

    String

    参数解释：

    调用结果。

    取值范围：

    调用正常时，返回“successful”。

状态码

错误码

请参见错误码。

相关文档