修改数据库用户的备注

功能介绍

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

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要了解请求Header参数说明。

调试

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

接口约束

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

URI

• URI格式

  PUT /v3/{project_id}/instances/{instance_id}/db-users/{user_name}/comment

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
  instance_id	是	参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
  user_name	是	参数解释： 数据库用户名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息

请求示例

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db-users/root/comment
{
    "comment": "this is a comment"
}

响应消息

• 正常要素说明

  表3 要素说明

  名称	参数类型	说明
  resp	String	参数解释： 调用结果。 取值范围： 调用正常时，返回“successful”。

• 正常响应样例

  {
      "resp": "successful"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。