DescribeAccounts - 查询数据库账号信息

更新时间: 2023-11-07 12:01:19

查询PolarDB集群的数据库账号信息。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群ID。

pc-***************
AccountNamestring

账号名称。

test_acc
PageNumberinteger

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

1
PageSizeinteger

每页记录数,取值范围:

  • 30
  • 50
  • 100

默认值为30

30

返回参数

名称类型描述示例值
object
PageRecordCountinteger

本页记录数。

1
RequestIdstring

请求ID。

155462B9-205F-4FFC-BB43-4855FE******
PageNumberinteger

页码。

1
Accountsobject []

账号信息详情。

AccountStatusstring

账号状态。取值范围:

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
Available
DatabasePrivilegesobject []

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

DBNamestring

数据库名称。

DBtest
AccountPrivilegestring

账号权限。

ReadOnly
AccountDescriptionstring

账号备注。

test
AccountPasswordValidTimestring

密码过期时间。

undefined
AccountTypestring

账户类型。取值范围:

  • Normal:普通账号。
  • Super:高权限账号。
Normal
AccountLockStatestring

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

  • UnLock:未锁定。
  • Lock:锁定。
UnLock
AccountNamestring

账号名。

test_acc

示例

正常返回示例

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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
400Database.ConnectErrordb instance %s connect failed, please check instance status and database processlist数据库实例连接失败,请检查实例状态和数据库进程列表
400Account.QueryErrorInstance %s query account error实例%s查询帐户错误
400Connect.TimeoutService can not connect to instance temporarily.服务暂时无法连接到实例
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间变更内容概要操作
2023-11-03OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-06-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
2023-04-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
阿里云首页 云原生数据库 PolarDB 相关技术圈