文档首页/云数据库 RDS/API参考/API v3（推荐）/实例管理/修改实例备注 - UpdatePostgresqlInstanceAlias
更新时间：2026-02-04 GMT+08:00
查看PDF
分享

修改实例备注 - UpdatePostgresqlInstanceAlias

功能介绍

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:updateRemark

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:modify

-

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/alias

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

alias

否

String

参数解释：

实例备注。

约束限制：

不涉及。

取值范围：

长度可在0~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线组成。

不传该参数，或参数值为空，将会删除原备注。

默认取值：

不涉及。

请求示例

修改实例的备注信息。

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/alias
{
     "alias": "alias-test"
}

响应消息

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

    名称

    参数类型

    说明

    resp

    String

    参数解释：

    调用结果。

    取值范围：

    successful：调用正常。

  • 正常响应要素说明 
    {
    "resp": "successful"
}

状态码

错误码

请参见错误码。

父主题：实例管理