获取数据表列表

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

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/spark/v1/apps/:app_id/tables
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	spark:app.table:read 读取数据表信息 spark:app.table:write 修改数据表信息

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
app_id	string	妙搭应用 id，可从妙搭应用 URL 中获取，如 https://miaoda.feishu.cn/app/app_4jcn5n11bpf5v 中的 app_4jcn5n11bpf5v 即为 app_id 示例值："app_4jcn5n11bpf5v"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数。默认10，最大500 示例值：10 默认值：10 数据校验规则： - 取值范围：1 ～ 500
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
env	string	否	访问的 database 环境，默认为 online（线上环境） 示例值：online、dev 默认值：online

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ items	app_table\[\]	数据表列表
└ 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	默认值

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "items": [
            {
                "name": "student",
                "description": "studect数据表",
                "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	请检查请求参数的类型、格式或值是否符合接口要求，具体可参考请求参数说明中的数据校验规则。