全部产品
Search
文档中心

云数据库 RDS:DescribeAccounts - 查询数据库账号信息

更新时间:Mar 13, 2024

该接口用于查询RDS实例的账号信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

说明 暂不支持 SQL Server 2017 集群系列实例。
rm-bp1v6z81ho9******
AccountNamestring

数据库账号名称。

zhttest
PageSizeinteger

每页记录数,取值:30~200。默认值:30

30
PageNumberinteger

页码。默认值:1。取值为大于 0 且不超过 Integer 的最大值。

1

返回参数

名称类型描述示例值
object

返回参数详情。

SystemAdminAccountStatusstring

超级权限账号是否启用,返回值如下:

  • True:已启用
  • False:未启用
说明 仅 SQL Server 实例支持超级权限账号,该参数有返回值。其他引擎实例的返回值为空。
True
SystemAdminAccountFirstActivationTimestring

超级权限账号首次启用时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 仅 SQL Server 实例返回该参数。
2023-10-17T07:51:22Z
PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

17F2EA6C-3CA2-528D-A263-DC29707AD652
TotalRecordCountinteger

总记录数。

3
Accountsobject []

账号信息列表。

AccountStatusstring

账号状态,返回值如下:

  • Unavailable:不可用
  • Available:可用
Available
AccountDescriptionstring

账号描述。

测试数据库账号
DBInstanceIdstring

账号所属实例 ID。

rm-bp1v6z81ho9******
PrivExceededstring

账号管理的数据库是否超过最大数量限制,返回值如下:

  • 1:是
  • 0:否
0
AccountTypestring

账号类型,返回值如下:

  • Normal:普通账号
  • Super:高权限账号
  • Sysadmin:具备超级权限(SA)的账号(仅 SQL Server 支持)
Normal
AccountNamestring

数据库账号名称。

test1
DatabasePrivilegesobject []

账号拥有的数据库权限列表。

DBNamestring

数据库名称。

test1
AccountPrivilegestring

账号的权限类型,返回值如下:

  • ReadWrite:读写
  • ReadOnly:只读
  • DDLOnly:仅 DDL
  • DMLOnly:只 DML
  • Custom:自定义(可以通过 SQL 命令修改)
ReadWrite
AccountPrivilegeDetailstring

账号权限类型对应的具体权限。请参见账号权限列表

SELECT,INSERT
ValidUntilstring

密码失效时间,返回值如下:

  • infinity:永不过期。
  • 返回为:未设置。
  • 返回实际密码失效时间。例如:2022-10-01T00:00:00Z,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)
说明 仅 PostgreSQL 实例返回该参数。
2022-10-01T00:00:00Z
CreateDBstring

是否拥有创建数据库权限,返回值如下:

  • t:是
  • f:否
说明 仅 PostgreSQL 实例返回该参数。
t
Replicationstring

是否拥有复制权限,返回值如下:

  • t:是
  • f:否
说明 仅 PostgreSQL 实例返回该参数。
t
CreateRolestring

是否拥有创建角色权限,返回值如下:

  • t:是
  • f:否
说明 仅 PostgreSQL 实例返回该参数。
t
BypassRLSstring

是否拥有安全策略 RLS 权限,返回值如下:

  • t:是
  • f:否
说明 仅 PostgreSQL 实例返回该参数。
f

示例

正常返回示例

JSON格式

{
  "SystemAdminAccountStatus": "True",
  "SystemAdminAccountFirstActivationTime": "2023-10-17T07:51:22Z",
  "PageNumber": 1,
  "RequestId": "17F2EA6C-3CA2-528D-A263-DC29707AD652",
  "TotalRecordCount": 3,
  "Accounts": {
    "DBInstanceAccount": [
      {
        "AccountStatus": "Available",
        "AccountDescription": "测试数据库账号",
        "DBInstanceId": "rm-bp1v6z81ho9******",
        "PrivExceeded": "0",
        "AccountType": "Normal",
        "AccountName": "test1",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "DBName": "test1",
              "AccountPrivilege": "ReadWrite",
              "AccountPrivilegeDetail": "SELECT,INSERT"
            }
          ]
        },
        "ValidUntil": "2022-10-01T00:00:00Z",
        "CreateDB": "t",
        "Replication": "t",
        "CreateRole": "t",
        "BypassRLS": "f"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IO.ExceptionIO exception, retry later.io异常。
400Database.ConnectErrorDatabase connect error. please check instance status and database processlist数据库连接异常,请检查实例状态及数据库的连接池
400InvalidDBInstanceStatus.NotSupportThe Specified instance status is not supported to query account list.-
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效,请选择正确的数据库引擎。
400Account.QueryErrorQuery Account failed, please check your input value.查询账户失败, 请检查请求参数。
400SqlExcutionFailedDatabase is already open and can only have one user at a time.数据库已打开,一次只能有一个用户。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-03-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:403
    新增错误码:404
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-07-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更