# 查询数据库

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

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

## 调用前准备

准备有目标工作区访问权限的个人访问令牌和工作区 ID。返回结果只包含当前身份可访问的数据库。

下方示例使用 `$AI_STUDIO_API_KEY` 作为 `X-API-Key`，使用 `$WORKSPACE_ID` 作为 `X-Workspace-ID`。

## 请求体

此接口不需要请求体。

## 请求示例

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

## 成功响应

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

响应字段如下。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `200`。 |
| `data.result` | array | 当前访问凭据可读取的数据库列表。 |
| `data.result[].db_name` | string | 数据库名称。 |
| `data.result[].display_name` | string | 显示名称；未设置时可省略。 |
| `data.result[].db_owner` | string | 数据库所有者；当前返回可能为空字符串。 |
| `data.result[].is_internal` | boolean | 是否为系统内置数据库。 |
| `data.result[].is_subscription` | boolean | 是否为订阅数据库。 |
| `data.result[].has_published` | boolean | 是否包含已发布的数据。 |
| `data.result[].tables` | object | 表元数据对象。 |
| `data.result[].views` | object | 视图元数据对象。 |
| `data.total` | integer | `result` 中的数据库数量。 |

从 `data.result[].db_name` 取得数据库名称后，使用[查询数据库中的表](list-database-tables.md)继续查看对象。

## 错误响应

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

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 15 45 40

* - HTTP 状态码
  - 常见原因
  - 建议操作
* - `401`
  - 凭据缺失或无效。
  - 检查 API Key 和工作区请求头。
* - `403`
  - 当前访问凭据无权访问工作区。
  - 检查工作区访问权限。
* - `500`
  - 查询数据库列表时发生服务端错误。
  - 稍后重试；持续失败时联系支持人员。
* - `503`
  - 数据库连接暂时不可用。
  - 稍后重试。
```

## 后续操作

保存目标项的标识，再[查询表信息](get-table-info.md)。