接口说明
适用引擎
- 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 | Read |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 说明 | rm-bp1v6z81ho9****** |
AccountName | string | 否 | 数据库账号名称。 |
zhttest |
PageSize | integer | 否 |
每页记录数,取值:30~200。默认值:30。 |
30 |
PageNumber | integer | 否 |
页码。默认值:1。取值为大于0且不超过Integer的最大值。 |
1 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
SystemAdminAccountStatus | string |
超级权限账号是否启用,返回值如下:
说明 | True |
SystemAdminAccountFirstActivationTime | string | 超级权限账号首次启用时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 | 2023-10-17T07:51:22Z |
PageNumber | integer | 页码。 |
1 |
RequestId | string |
请求ID。 |
17F2EA6C-3CA2-528D-A263-DC29707AD652 |
TotalRecordCount | integer |
总记录数。 |
3 |
Accounts | object [] |
账号信息列表。 |
|
AccountStatus | string |
账号状态,返回值如下:
|
Available |
AccountDescription | string |
账号描述。 |
测试数据库账号 |
DBInstanceId | string |
账号所属实例ID。 |
rm-bp1v6z81ho9****** |
PrivExceeded | string |
账号管理的数据库是否超过最大数量限制,返回值如下:
|
0 |
AccountType | string |
账号类型,返回值如下:
|
Normal |
AccountName | string |
数据库账号名称。 |
test1 |
DatabasePrivileges | object [] |
账号拥有的数据库权限列表。 |
|
DBName | string |
数据库名称。 |
test1 |
AccountPrivilege | string |
账号的权限类型,返回值如下:
|
ReadWrite |
AccountPrivilegeDetail | string |
账号权限类型对应的具体权限。请参见账号权限列表。 |
SELECT,INSERT |
ValidUntil | string |
密码失效时间,返回值如下:
说明 | 2022-10-01T00:00:00Z |
CreateDB | string | 是否拥有创建数据库权限,返回值如下:
说明 | t |
Replication | string | 是否拥有复制权限,返回值如下:
说明 | t |
CreateRole | string | 是否拥有创建角色权限,返回值如下:
说明 | t |
BypassRLS | string | 是否拥有安全策略RLS权限,返回值如下:
说明 | 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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 错误码发生变更 | 看变更集 | ||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/155739.html