# 获取数据表详细信息

获取应用下的数据表详情，包含数据表名称、描述，以及数据表列信息等字段。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/spark/v1/apps/:app_id/tables/:table_name
HTTP Method | GET
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 读取数据表相关信息(spark:app.table:read)<br>修改数据表相关信息(spark:app.table:write)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
app_id | string | 妙搭应用 id，可从妙搭应用 URL 中获取，如 https://miaoda.feishu.cn/app/app_4jcn5n11bpf5v 中的 app_4jcn5n11bpf5v 即为 app_id<br>**示例值**："app_4jcn5n11bpf5v"
table_name | string | 妙搭数据表表名，必须属于 app_id 对应的妙搭应用，可从妙搭应用数据库管理中获取<br>**示例值**："student_table"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
env | string | 否 | 访问的 database 环境，默认为 online（线上环境）<br>**示例值**：`online`、`dev`<br>**默认值**：`online`

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
name | string | 数据表名，如 student
description | string | 数据表描述
columns | app_table_column\[\] | 数据表列
name | string | 列名
description | string | 列描述
data_type | string | 数据库数据类型
is_primary_key | boolean | 是否是主键
is_unique | boolean | 是否唯一
is_auto_increment | boolean | 是否是自增
is_array | boolean | 是否是数组类型
is_allow_null | boolean | 是否允许为空
default_value | string | 默认值

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "name": "student",
        "description": "这是student表的描述",
        "columns": [
            {
                "name": "column_name",
                "description": "column_name的描述",
                "data_type": "varchar",
                "is_primary_key": false,
                "is_unique": false,
                "is_auto_increment": false,
                "is_array": false,
                "is_allow_null": false,
                "default_value": "默认值"
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 3340001 | param is invalid | 请检查请求参数的类型、格式或值是否符合接口要求，具体可参考请求参数说明中的数据校验规则。