ModifyAccountDescription - 修改账号备注

更新时间:
复制 MD 格式

调用 ModifyAccountDescription 接口,修改指定云数据库 MongoDB 版实例中某个账号的备注信息。

接口说明

  • 异步接口:返回 RequestId 表示已受理。

  • 系统账号处理:root 允许修改备注(库内账号,更新 accounts 表,线上标准能力);__cloud 前缀等系统账号禁改,报 InvalidAccountName.Malformed。

  • 账号不存在或 DBName 不匹配时返回 InvalidAccountName.NotFound。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:ModifyAccountDescription

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无 无

请求参数

名称

类型

必填

描述

示例值

DBInstanceId

string

是

实例 ID。

dds-bp2356****

AccountName

string

是

待修改备注信息的账号名。

root

DBName

string

否

账号所属库

admin

AccountDescription

string

是

设置账号的备注信息。

  • 不能以 http:// 或者 https:// 开头。

  • 以中文、英文字母开头。

  • 可以包含中文、英文字符、下划线(_)、短划线(-)和数字,长度为 2~256 个字符。

superadmin

CharacterType

string

否

修改账号备注信息类型。取值:

  • db: shard 账号

  • cs:config server 账号

  • normal:默认值,副本集账号

枚举值:

  • cs :

    Config Server 账号

  • normal :

    副本集账号(默认值)

  • db :

    Shard 账号

normal

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

59DE9FC2-7B40-45CF-9011-7327A8A771A2

示例

正常返回示例

JSON格式

{
  "RequestId": "59DE9FC2-7B40-45CF-9011-7327A8A771A2"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidAccountDescription.Malformed Specified parameter AccountDescription is not valid. 指定的参数AccountDescription无效。
400 InvalidAccountName.NotFound Specified account name does not exist.
400 InsType.NotSupport Specified instance type dose not support this operation. 指定的实例类型不支持此操作。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。