查询租户下的数据库列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
oceanbase:DescribeDatabases |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TenantId |
string |
否 |
租户 ID。 |
t4pnum**** |
| PageNumber |
integer |
否 |
分页查询的页码。
|
1 |
| PageSize |
integer |
否 |
分页查询时设置的每页行数。
|
10 |
| DatabaseName |
string |
否 |
数据库名称。 不能使用某些预留关键字，如 test、mysql。 |
sms_pre |
| SearchKey |
string |
否 |
查询列表的删选关键字。 |
pay |
| WithTables |
boolean |
否 |
是否返回数据库中的表信息。 说明
如果表的数量过大则可能导致接口超时。 |
true |
| InstanceId |
string |
否 |
集群 ID。 |
ob****n0abo9uo |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
请求的返回结果。 |
||
| TotalCount |
integer |
租户中的数据库总数。 |
1 |
| Databases |
array<object> |
租户中的数据库列表。 |
|
|
array<object> |
租户中的数据库列表。 |
||
| Status |
string |
数据库的状态。
|
ONLINE |
| Description |
string |
数据库的描述信息。 |
test db |
| Encoding |
string |
数据库的编码。目前支持 utf8mb4、gbk 等编码。 |
utf8mb4 |
| DbType |
string |
数据库类型。 |
mysql |
| DatabaseName |
string |
数据库名称。 |
sms_pre |
| CreateTime |
string |
创建时间。 |
2022-02-21 15:41:06 |
| Users |
array<object> |
对该数据库赋权的账号列表信息。 |
|
|
object |
对该数据库赋权的账号列表信息。 |
||
| UserType |
string |
账号类型。
|
Normal |
| Role |
string |
账号赋予该库的角色权限。 对于 MySQL 模式，角色为数据库（Database）级别，其有以下几类：
|
ReadOnly |
| UserName |
string |
账号名称。 |
user_pay_ro |
| Privileges |
string |
用户授予数据库自定义权限时，privileges 返回自定义的权限内容，以逗号 "," 分割；其余时间 privileges 不返回数据。 |
select,delete,update |
| TenantId |
string |
租户 ID。 |
t4pnum**** |
| Tables |
array<object> |
数据库表列表信息。 |
|
|
object |
数据库表列表信息。 |
||
| TableName |
string |
数据库表名。 |
testTables |
| RequiredSize |
number |
所需容量，单位：GB。 |
5.67 GB |
| DataSize |
number |
实际数据大小，单位：GB。 重要 该字段后期后台不再输出, 请使用 RequiredSize。 |
5.67 GB |
| Collation |
string |
字符序。 |
utf8mb4_general_ci |
| InstanceId |
string |
所属集群 ID。 |
obsdh2f**** |
| TenantName |
string |
租户名。 |
tenantABC |
| RequestId |
string |
请求 ID。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"Databases": [
{
"Status": "ONLINE",
"Description": "test db",
"Encoding": "utf8mb4",
"DbType": "mysql",
"DatabaseName": "sms_pre",
"CreateTime": "2022-02-21 15:41:06",
"Users": [
{
"UserType": "Normal",
"Role": "ReadOnly",
"UserName": "user_pay_ro",
"Privileges": "select,delete,update"
}
],
"TenantId": "t4pnum****",
"Tables": [
{
"TableName": "testTables"
}
],
"RequiredSize": 0,
"DataSize": 0,
"Collation": "utf8mb4_general_ci",
"InstanceId": "obsdh2f****",
"TenantName": "tenantABC"
}
],
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。