---
orphan: true
---

# 查看表概览

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

列出指定数据库中的表及各表列名。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/table/overview
```

## 调用前准备

先[查询数据库列表](list-databases.md)取得数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/overview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "id": '"$DATABASE_ID"'
  }'
```

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

::::{tab-set}
:::{tab-item} 请求体

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 是 | 数据库 ID。 |

:::
::::

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

## 成功响应

成功时返回 `200` 和表概览。

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tables": [
      {
        "name": "orders",
        "columns": ["id", "amount"]
      }
    ]
  }
}
```

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

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |

:::
:::{tab-item} 表概览

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `tables` | object（对象数组） | 数据库中的表概览。 |

:::
:::{tab-item} 表

下面表格展开响应示例中 `data.tables` 数组的每一项；每一行是该数组项的一个字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `name` | string | 表名称。 |
| `columns` | string（字符串数组） | 表的列名列表。 |

:::
::::

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

## 错误响应

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

```json
{
  "code": "ErrServer",
  "msg": "服务器内部错误",
  "data": null
}
```

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 错误代码。 |
| `msg` | string | 错误信息。 |
| `data` | null | 错误响应中的附加数据；本示例为 `null`。 |

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