调用DescribeAccounts接口查询云数据库MongoDB实例的数据库账号信息。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAccounts

系统规定参数。取值:DescribeAccounts

RegionId String cn-hangzhou

地域ID,您可以通过调用DescribeRegions接口查询。

DBInstanceId String dds-bp1fd530f271****

实例ID。

AccountName String root

账号名,取值:root

返回数据

名称 类型 示例值 描述
RequestId String B562A65B-39AB-4EE8-8635-5A222054FB35

请求ID。

Accounts Array of Account

账号信息列表。

Account
CharacterType String mongos

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

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

账号的状态,取值说明:

  • Unavailable:不可用。
  • Available:可用。
AccountDescription String 管理员

账号备注信息。

DBInstanceId String dds-bp1fd530f271****

账号所属的实例ID。

AccountName String root

账号名。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeAccounts
&DBInstanceId=dds-bp1fd530f271****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAccountsResponse>
    <RequestId>B562A65B-39AB-4EE8-8635-5A222054FB35</RequestId>
    <Accounts>
        <CharacterType>mongos</CharacterType>
        <AccountStatus>Available</AccountStatus>
        <AccountDescription>管理员</AccountDescription>
        <DBInstanceId>dds-bp1fd530f271****</DBInstanceId>
        <AccountName>root</AccountName>
    </Accounts>
</DescribeAccountsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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