更新时间:2025-07-16 GMT+08:00
分享

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

功能介绍

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

调试

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

接口约束

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

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释

    租户在某一Region下的项目ID。

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

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

name

String

参数解释

数据库名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

comment

String

参数解释

数据库备注。

约束限制

不涉及。

取值范围

1~512

默认取值

不涉及。

请求示例

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

响应消息

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

    名称

    参数类型

    说明

    resp

    String

    参数解释

    调用结果。

    取值范围

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

状态码

错误码

请参见错误码

相关文档