DocsICP FilingConsole
Documentation

DescribeAccounts - 查询数据库账号信息

Updated at:
Copy as MD
Product
My Favorites

该接口用于查询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:DescribeAccounts

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
 无

请求参数

名称

类型

必填

描述

示例值
DBInstanceId

string

是

实例 ID。可调用 DescribeDBInstances 获取。

说明

暂不支持 SQL Server 2017 集群系列实例。

rm-bp1v6z81ho9******
AccountName

string

否

数据库账号名称。

zhttest
PageSize

integer

否

每页记录数，取值：30~200。默认值：30。

30
PageNumber

integer

否

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

1

返回参数

名称

类型

描述

示例值

object

返回参数详情。

Accounts

object

DBInstanceAccount

array<object>

账号信息列表。

array<object>

账号详情如下。

AccountDescription

string

账号描述。

测试数据库账号
AccountName

string

数据库账号名称。

test1
AccountStatus

string

账号状态，返回值如下：

  • Unavailable：不可用

  • Available：可用

Available
AccountType

string

账号类型，返回值如下：

  • Normal：普通账号

  • Super：高权限账号

  • Sysadmin（仅 SQL Server 支持）：具备超级权限（SA）的账号

  • GlobalRO（仅 SQL Server 支持）：全局只读账号

Normal
BypassRLS

string

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

  • t：是

  • f：否

说明

仅 PostgreSQL 实例返回该参数。

f
CheckPolicy

boolean

是否应用密码策略

说明

仅 SQLServer 实例返回该参数。

true
CreateDB

string

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

  • t：是

  • f：否

说明

仅 PostgreSQL 实例返回该参数。

t
CreateRole

string

是否拥有创建角色权限，返回值如下：

  • t：是

  • f：否

说明

仅 PostgreSQL 实例返回该参数。

t
DBInstanceId

string

账号所属实例 ID。

rm-bp1v6z81ho9******
DatabasePrivileges

object

DatabasePrivilege

array<object>

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

object

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

AccountPrivilege

string

账号的权限类型，返回值如下：

  • ReadWrite：读写

  • ReadOnly：只读

  • DDLOnly：仅 DDL

  • DMLOnly：只 DML

  • Custom：自定义（可以通过 SQL 命令修改）

ReadWrite
AccountPrivilegeDetail

string

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

SELECT,INSERT
DBName

string

数据库名称。

test1
PasswordExpireTime

string

密码过期时间

说明

仅 SQLServer 实例返回该参数。

2024-10-21
PrivExceeded

string

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

  • 1：是

  • 0：否

0
Replication

string

是否拥有复制权限，返回值如下：

  • t：是

  • f：否

说明

仅 PostgreSQL 实例返回该参数。

t
ValidUntil

string

密码失效时间，返回值如下：

  • infinity：永不过期。

  • 返回为空：未设置。

  • 返回实际密码失效时间。例如：2022-10-01T00:00:00Z，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）

说明

仅 PostgreSQL 实例返回该参数。

2022-10-01T00:00:00Z
PageNumber

integer

页码。

1
RequestId

string

请求 ID。

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

string

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

说明

仅 SQL Server 实例返回该参数。

2023-10-17T07:51:22Z
SystemAdminAccountStatus

string

超级权限账号是否启用，返回值如下：

  • True：已启用

  • False：未启用

说明

仅 SQL Server 实例支持超级权限账号，该参数有返回值。其他引擎实例的返回值为空。

True
TotalRecordCount

integer

总记录数。

3
ResourceGroupId

string

资源组 ID。

rg-acfmy****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述
400 %s DB Operation Failed:%s.
400 IO.Exception IO exception, retry later. io异常。
400 Database.ConnectError Database connect error. please check instance status and database processlist 数据库连接异常，请检查实例状态及数据库的连接池
400 InvalidDBInstanceStatus.NotSupport The Specified instance status is not supported to query account list.
400 InvalidEngine.Malformed Specified engine is not valid. 当前数据库引擎无效，请选择正确的数据库引擎。
400 Account.QueryError Query Account failed, please check your input value. 查询账号失败， 请检查请求参数。例如RDS MySQL账号名称可能含特殊字符。
400 SqlExcutionFailed Database is already open and can only have one user at a time. 数据库已打开，一次只能有一个用户。
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. sql命令执行失败或执行超时
400 ConcurrentLimit The request processing has been concurrent limit. 请求处理已达到并发限制。
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. 套餐实例不允许单独操作。
400 Price.PricingPlanResultNotFound Pricing plan price result not found. 定价计划价格结果没有找到。
400 Order.NoRealNameAuthentication You 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. 您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. 您的账户可用额度小于0，请先充值后再尝试购买。
400 CommodityServiceCalling.Exception Failed to call commodity service. 调用商品服务返回失败。
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. 客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 您购买的模块不合法，请重新购买。
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. 客户您好，该地域已裁撤。
400 Price.CommoditySys Commodity system call exception. 商品系统调用异常。
400 Pay.InsufficientBalance Insufficient available balance. 可用金不足。
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 您选购的周期有问题，请重新选购。
400 pay.noCreditCard Account not bound to credit card. 账户未绑定信用卡。
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. 您选购的服务存在未支付订单，请支付或作废后再下单。
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. 您的基本信息未完善，请在操作前先完善您的基本信息。
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. 您的账户出现异常，详情请联系客服。
400 Api.NotSupport Specified api is not supported. 当前接口不支持。
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. 存在禁止下单的标签，请联系您的分销商处理
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. 提供的DBInstanceId不存在。
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type 当前实例规格不支持该存储类型。
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400 KmsApiError User secret key invalid. 用户密钥失效。
400 System.SaleValidateFailed Sales expression validation system error. 销售表达式校验系统错误。
400 Abs.InvalidAccount.NotFound account is not found. 账户不存在。
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. 当前实例引擎版本不支持归档冷数据。
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. 当前内核版本不支持归档冷数据。
400 IncorrectTargetClasscode The current instance type does not support this operation. 当前规格不支持此操作。
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. 链接地址名重复，请重新设置连接字符串。
400 RequiredParam.NotFound Required input param is not found. 没有传入必要的参数。
400 Parameters.Invalid Parameter error, please check the parameters. 参数错误，请检查参数。
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 实例释放后的归档备份保留策略无效。
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB实例引擎类型不支持此操作。
400 Pay.NoCreditCard No credit cards. 无信用卡。
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. vpc网络类型实例不支持此操作。
400 MirrorInsExists Specified DB instance mirror ins already existed. 当前数据库实例镜像已存在。
400 UnsupportedClassCode The specified DB instance class stops selling. 实例规格停止售卖。
400 InvalidBackupSet The specified database does not exist in the backup set. 备份集中没有指定的数据库。
400 OrdTCommodityQueryError Failed to query for product. 查询产品失败。
400 ProductInstanceReleased The instance has been released. Please check before placing the order. 实例已释放，请核实后下单。
400 RegionEndTimeDissolvedIndia The region is no longer supported. 指定的地域无效。
400 DbossGeneralError The instance is being created. Please wait. 实例正在创建中，请稍等。或者RDS SQL Server账号名称可能含特殊字符。
400 InvalidCharacter.DbOrAccount The database name or account name contains invalid characters. 数据库名称或者账号名称包含非法字符。
400 NoAvailablePaymentMethod No payment method is specified for account. We recommend that you add a payment method. 账户未指定付款方式。我们建议您添加付款方式。
500 ExternalFailure The request processing has failed due to external service failure. 请求服务失败，请稍后重试。
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 请求服务失败，请稍后再试或联系服务人员。
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. 由于rds api服务失败，请求处理失败。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 当前实例状态不支持此操作。
403 OrderStatus.UnPaid The specified db instance has unpaid order. 实例当前存在未支付订单，请支付后重试。
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. 缩容目标容量不能小于当前存储空间使用量
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD盘不支持此操作，请升级至ESSD。
403 InvalidUserOperatorPermission The user permission does not support this operation. 用户权限不支持此操作。
403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的VSwitchId格式不正确或为空
403 IncorrectMinorVersion Current engine minor version does not support operations. 当前引擎小版本不支持此操作。
403 OperationDenied.ZoneResource There is no available zone for inventory. 没有可用的库存区域。
403 NotInFlowController Sorry,no permission. 非集团上云用户不可用，无权限。
403 InvalidKmsKey Kms key is disabled. Kms key已禁用。
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 当前数据库实例级别不支持此操作。
403 GuardDBInstanceNotSupport Guard instance does not support this operation. 灾备实例不支持此操作。
404 InvalidDBInstanceName.NotFound The database instance does not exist. 数据库实例名称不存在。请确认数据名称是否正确。
404 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 操作失败，实例处于锁定状态。
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. 当前实例未授权访问密钥管理服务。
404 Request.NotFound The requested resource is not available. 请求的资源不可用。
404 HostInfo.NotFound The specified host info is not found. 指定的主机信息不存在。
408 NetworkOrSqlTimeoutError Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later. 由于潜在的SQL Server过载或实例账号过多，导致查询超时失败。

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

变更历史

更多信息，参考变更详情。