获取数据表详细信息

获取数据表详细信息

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/apaas/v1/workspaces/:workspace_id/tables/:table_name
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	app_engine:workspace.table:read 读取工作空间及数据表相关信息 app_engine:workspace.table:write 修改工作空间及数据表相关信息

请求头

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

路径参数

名称	类型	描述
workspace_id	string	工作空间id，可以从数据平台的 URL 中获取，如 https://apaas.feishu.cn/suda/workspace/workspace_aadimx5uzpsls/table-manage/main?tableId=table_1846786627963081&tab=objectManage 中的 workspace_aadimx5uzpsls 就是 workspace_id 示例值："workspace_aadimx5uzpsls"
table_name	string	数据表表名 示例值："table_name_1"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ name	string	数据表名，如 student
└ description	string	数据表描述
└ columns	workspace_data_table_column_info\[\]	数据表列
└ 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": {
        "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	2320001	param is invalid	请检查请求参数的类型、格式或值是否符合接口要求，具体可参考请求参数说明中的数据校验规则。