# 查看数据库列表

列出你可以访问的数据库。使用响应中的数据库名称查看其中的表和视图。

```text
POST https://api.moi.matrixorigin.cn/v5/meta/db/info
```

## 调用前准备

准备有目标工作区访问权限的[个人访问令牌](../../../../../guides/genesis/api-keys.md#创建和管理个人访问令牌)和[目标工作区 ID](../../../../../guides/ai-studio/resource-center/workspace.md#复制工作区-id)。


## 调用示例

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 调用示例

```bash
curl -X POST "https://api.moi.matrixorigin.cn/v5/meta/db/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

:::::
:::::{tab-item} 参数说明

此调用没有请求体、路径参数或查询参数。

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code": 200, "data": {"result": [{"db_name": "sales", "display_name": "销售数据"}], "total": 1}}

```

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `200`。 |
| `data` | object | 数据库列表。 |

:::
:::{tab-item} 数据库列表

下面表格展开响应示例中的 `data` 对象；每一行是该对象的一个字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `result` | array of object | 当前身份可读取的数据库列表。 |
| `total` | integer | 返回的数据库数量。 |

:::
:::{tab-item} 数据库信息

下面表格展开响应示例中 `data` 下的 `result` 列表；每一行是列表中一个数据库对象的字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `db_name` | string | 数据库名称。 |
| `display_name` | string | 显示名称。 |

:::
::::

:::::
::::::
:::::::



响应只包含当前身份可访问的数据库。选择 `result` 列表中数据库的 `db_name` 后，使用[查看数据库中的表和视图列表](list-database-tables.md#调用前准备)继续查看对象。

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code": 503, "message": "服务暂不可用"}

```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 错误状态码。 |
| `message` | string | 错误信息。 |

:::::
::::::
:::::::


## 后续操作

[查看数据库中的表和视图列表](list-database-tables.md#调用前准备)。