全部产品
Search
文档中心

云数据库 MongoDB:DescribeAccounts - 查询实例的数据库账号信息

更新时间:Jan 17, 2023

查询MongoDB实例的数据库账号信息。

接口说明

说明 本接口目前仅支持查询root账号的信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
dds:DescribeAccounts LIST
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string

实例ID。

dds-bp1fd530f271****
AccountName string

账号名,取值:root

root

返回参数

名称 类型 描述 示例值
object
RequestId string

请求ID。

B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts array

账号信息列表。

object
CharacterType string

账号的角色类型,取值说明:

  • db: shard角色。
  • cs:config server角色。
  • mongos:mongos角色。
  • logic:分片集群实例。
  • normal:副本集实例。
mongos
AccountStatus string

账号的状态,取值说明:

  • Unavailable:不可用。
  • Available:可用。
Available
AccountDescription string

账号备注信息。

管理员
DBInstanceId string

账号所属的实例ID。

dds-bp1fd530f271****
AccountName string

账号名。

root

示例

正常返回示例

JSON格式

{
  "RequestId": "B562A65B-39AB-4EE8-8635-5A222054FB35",
  "Accounts": {
    "Account": [
      {
        "CharacterType": "mongos",
        "AccountStatus": "Available",
        "AccountDescription": "管理员",
        "DBInstanceId": "dds-bp1fd530f271****",
        "AccountName": "root"
      }
    ]
  }
}

错误码

Http code 错误码 错误信息
403 ResponseEmptyError The Response is empty, maybe server request timeout.

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