调用DescribeAccounts接口查询PolarDB集群的数据库账号信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeAccounts。

DBClusterId String 是 pc-***************

集群ID。
AccountName String 否 test_acc

账号名称。
PageNumber Integer 否 1

页码，取值范围为大于0但不超过Integer最大值的整数。默认值为1。

PageSize Integer 否 30

每页记录数，取值范围：

  • 30
  • 50
  • 100

默认值为30。

返回数据

名称 类型 示例值 描述
PageRecordCount Integer 1

本页记录数。
RequestId String 155462B9-205F-4FFC-BB43-4855FE******

请求ID。
PageNumber Integer 1

页码。
Accounts Array of DBAccount

账号信息详情。
AccountStatus String Available

账号状态。取值范围：

  • Creating：创建中。
  • Available：可用。
  • Deleting：删除中。
DatabasePrivileges Array of DatabasePrivilege

目标账号拥有的数据库权限详情。
DBName String DBtest

数据库名称。
AccountPrivilege String ReadOnly

账号权限。
AccountDescription String test

账号备注。
AccountPasswordValidTime String undefined

密码过期时间。
AccountType String Normal

账户类型。取值范围：

  • Normal：普通账号。
  • Super：高权限账号。
AccountLockState String UnLock

账号锁定状态。取值范围：

  • UnLock：未锁定。
  • Lock：锁定。
AccountName String test_acc

账号名。
AccountPassword String Test1111

账号密码。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeAccounts
&DBClusterId=pc-***************
&AccountName=test_acc
&PageNumber=1
&PageSize=30
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeAccountsResponse>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>155462B9-205F-4FFC-BB43-4855FE******</RequestId>
    <PageNumber>1</PageNumber>
    <Accounts>
        <AccountStatus>Available</AccountStatus>
        <DatabasePrivileges>
            <DBName>DBtest</DBName>
            <AccountPrivilege>ReadOnly</AccountPrivilege>
        </DatabasePrivileges>
        <AccountDescription>test</AccountDescription>
        <AccountPasswordValidTime>undefined</AccountPasswordValidTime>
        <AccountType>Normal</AccountType>
        <AccountLockState>UnLock</AccountLockState>
        <AccountName>test_acc</AccountName>
        <AccountPassword>Test1111</AccountPassword>
    </Accounts>
</DescribeAccountsResponse>

JSON格式 

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

{
  "PageRecordCount" : 1,
  "RequestId" : "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber" : 1,
  "Accounts" : [ {
    "AccountStatus" : "Available",
    "DatabasePrivileges" : [ {
      "DBName" : "DBtest",
      "AccountPrivilege" : "ReadOnly"
    } ],
    "AccountDescription" : "test",
    "AccountPasswordValidTime" : "undefined",
    "AccountType" : "Normal",
    "AccountLockState" : "UnLock",
    "AccountName" : "test_acc",
    "AccountPassword" : "Test1111"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定的参数PageSize无效
400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定的参数PageNumber无效
400 Database.ConnectError db instance %s connect failed, please check instance status and database processlist db实例 %s 连接失败，请检查实例状态和数据库进程列表
400 Account.QueryError Instance %s query account error 实例%s查询帐户错误
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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