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

功能介绍

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

• 调用接口前，您需要了解API 认证鉴权。

调试

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

接口约束

• 如果您需要使用该功能，请联系客服提交开启修改数据库备注权限的申请。
• 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。
• 更新备注的操作不受数据库是否存在影响。
  • 若备注存在则更新，不存在则自动新建备注。
  • 更新为空值备注将会被删除。
  • 若新建备注过程中数据库被删除或不存在，则备注依旧会保存。

• 该方法只针对新版本的实例生效，必须大于等于指定的内核版本，如果不符合内核小版本要求，请参考升级内核小版本升级至最新。
  • RDS for MySQL 5.6：大于等于5.6.51.3。
  • RDS for MySQL 5.7：大于等于5.7.33.1。
  • RDS for MySQL 8.0：大于等于8.0.25.1。
• 除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。
• 如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

请求示例

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

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

响应消息

• 正常要素说明

  表3 要素说明

  名称	参数类型	说明
  resp	String	调用正常时，返回“successful”。

• 正常响应样例

  {
      "resp": "successful"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。