调用DescribeAccounts接口查询实例的账号信息。
说明 该接口暂不支持SQL Server 2017集群版、PostgreSQL、PPAS实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeAccounts | 系统规定参数,取值:DescribeAccounts。 |
| DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx | 实例ID。 |
| AccountName | String | 否 | test1 | 数据库账号名称。 |
| PageSize | Integer | 否 | 30 | 每页记录数。默认值:30。 |
| PageNumber | Integer | 否 | 1 | 页码,取值:大于0且不超过Integer的最大值。 默认值:1。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Accounts | Array | 账号信息列表。 |
|
| DBInstanceAccount | |||
| DBInstanceId | String | rm-uf6wjk5xxxxxxx | 账号所属实例ID。 |
| AccountName | String | test1 | 数据库账号名称。 |
| AccountStatus | String | Available | 账号状态:
|
| AccountDescription | String | 测试数据库账号 | 账号描述。 |
| DatabasePrivileges | Array | 账号拥有的数据库权限列表。 |
|
| DatabasePrivilege | |||
| DBName | String | test1 | 数据库名称。 |
| AccountPrivilege | String | ReadWrite | 账号的权限类型,取值:
|
| AccountPrivilegeDetail | String | SELECT,INSERT | 账号权限类型对应的具体权限。请参见账号权限列表。 |
| AccountType | String | Normal | 账号类型,取值:
|
| PrivExceeded | String | 0 | 账号管理的数据库是否超过最大数量限制,取值:
|
| RequestId | String | A2E94301-D07F-4457-9B49-6AA2BB388C85 | 请求ID。 |
| SystemAdminAccountFirstActivationTime | String | 2020-02-06T11:00:00Z | 超级权限账号首次启用时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
说明 仅当SysadminAccount为True时返回,其余情况为空。
|
| SystemAdminAccountStatus | String | True | 超级权限账号是否启用。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeAccounts &DBInstanceId=rm-uf6wjk5xxxxxxx &<公共请求参数>
正常返回示例
XML 格式
<DescribeAccountsResponse> <Accounts> <DBInstanceAccount> <DatabasePrivileges> <DatabasePrivilege> <AccountPrivilege>ReadWrite</AccountPrivilege> <AccountPrivilegeDetail>SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EXECUTE,EVENT,TRIGGER</AccountPrivilegeDetail> <DBName>testdb</DBName> </DatabasePrivilege> </DatabasePrivileges> <AccountStatus>Available</AccountStatus> <AccountDescription></AccountDescription> <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId> <AccountName>testacc02</AccountName> <PrivExceeded>0</PrivExceeded> <AccountType>Normal</AccountType> </DBInstanceAccount> </Accounts> <RequestId>A2E94301-D07F-4457-9B49-6AA2BB388C85</RequestId> </DescribeAccountsResponse>
JSON 格式
{
"Accounts": {
"DBInstanceAccount": [
{
"DatabasePrivileges": {
"DatabasePrivilege": [
{
"AccountPrivilege": "ReadWrite",
"AccountPrivilegeDetail": "SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EXECUTE,EVENT,TRIGGER",
"DBName": "testdb"
}
]
},
"AccountStatus": "Available",
"AccountDescription": "",
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"AccountName": "testacc02",
"PrivExceeded": "0",
"AccountType": "Normal"
}
]
},
"RequestId": "A2E94301-D07F-4457-9B49-6AA2BB388C85"
}
错误码
访问错误中心查看更多错误码。