该接口用于查询RDS实例的账号信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeAccounts | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 说明
暂不支持SQL Server 2017集群系列实例。
| rm-bp1v6z81ho9****** |
| AccountName | string | 否 | 数据库账号名称。 | zhttest |
| PageSize | integer | 否 | 每页记录数，取值：30~200。默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码。默认值：1。取值为大于0且不超过Integer的最大值。 | 1 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 查询账户失败， 请检查请求参数。 |
| 400 | SqlExcutionFailed | Database is already open and can only have one user at a time. | 数据库已打开，一次只能有一个用户。 |
| 403 | IncorrectDBInstanceState | Current DB instance state 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. | 操作失败，实例处于锁定状态。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-03-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-09-15 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-09-15 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-07-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
