# 查询表信息

查看表的字段定义和行数，不返回表中的数据行。

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

## 调用前准备

准备个人访问令牌、工作区 ID、数据库名称和表名称。可先[查询数据库中的表](list-database-tables.md)确认对象名称。

下方示例使用 `$AI_STUDIO_API_KEY`、`$WORKSPACE_ID`、`$DATABASE` 和 `$TABLE`。

## 请求体

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `db_name` | string | 是 | 表所在的数据库名称。 |
| `table_name` | string | 是 | 要查询的表名称。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/meta/table/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{\"db_name\":\"$DATABASE\",\"table_name\":\"$TABLE\"}"
```

## 成功响应

```json
{
  "code": 200,
  "data": {
    "columns": [{"name": "id", "data_type": "INT", "nullable": "NO", "default_value": "", "key_type": "PRI", "comment": ""}],
    "total": 1,
    "rows": 42
  }
}
```

响应字段如下。

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `200`。 |
| `data.columns` | array | 表的列定义列表。 |
| `data.columns[].name` | string | 列名称。 |
| `data.columns[].data_type` | string | 数据类型。 |
| `data.columns[].nullable` | string | 是否允许空值；`YES` 表示允许，`NO` 表示不允许。 |
| `data.columns[].default_value` | string | 默认值；未设置时为空字符串。 |
| `data.columns[].key_type` | string | 键类型。 |
| `data.columns[].comment` | string | 列备注。 |
| `data.total` | integer | 列数量。 |
| `data.rows` | integer | 表的行数，不返回数据行本身。 |

需要只查看字段时，使用[查看表字段](list-table-columns.md)；需要查看建表语句时，使用[查看建表语句](get-table-ddl.md)。

## 错误响应

```json
{
  "code": 404,
  "message": "对象不存在"
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 常见原因
  - 建议操作
* - `400`
  - 请求体无法解析，或缺少 `db_name`、`table_name`。
  - 补齐两个非空字段。
* - `401`
  - 凭据缺失或无效。
  - 检查 API Key 和工作区请求头。
* - `403`
  - 当前访问凭据没有读取该表的权限。
  - 使用具有相应数据库权限的凭据重试。
* - `404`
  - 数据库或表不存在。
  - 检查对象名称和数据库名称。
* - `500`
  - 读取表信息或统计行数时发生服务端错误。
  - 稍后重试；持续失败时联系支持人员。
* - `503`
  - 数据库连接暂时不可用。
  - 稍后重试。
```

## 后续操作

返回列表时[查看表字段](list-table-columns.md)。