查询租户下的数据库列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-10-30 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-04 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-09-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-01-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |