飞书开放平台 Server API 文档

主题

获取多维表格元数据 ​

获取指定多维表格的元数据信息，包括多维表格名称、多维表格版本号、多维表格是否开启高级权限等。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/bitable/v1/apps/:app_token
HTTP MethodGET
接口频率限制20 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可base:app:read 获取多维表格信息 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格

请求头 ​

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

路径参数 ​

名称类型描述
app_tokenstring多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： app_token.png
- 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。
了解更多，参考多维表格 app_token 获取方式。
示例值："appbcbWCzen6D8dezhoCH2RpMAh"

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ appdisplay_app多维表格元数据
    └ app_tokenstring多维表格的唯一标识 app_token
    └ namestring多维表格的名称
    └ revisionint多维表格的版本号。对多维表格进行修改时更新，如新增、删除数据表，修改数据表名等，初始为 1，每次更新+1
    └ is_advancedboolean多维表格是否开启了高级权限。取值包括： - true：开启了高级权限 - false：关闭了高级权限
了解更多参考飞书帮助中心文档使用多维表格高级权限。
    └ time_zonestring多维表格的时区
    └ formula_typeint多维表格的公式字段类型。可结合字段相关 API使用。
可选值有：
- 1: 不支持指定公式字段类型 - 2: 支持指定公式字段类型
    └ advance_versionstring文档高级权限版本。可结合自定义角色 API使用。
可选值有：
- v1: v1版本 - v2: v2版本

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "app": {
            "app_token": "appbcbWCzen6D8dezhoCH2RpMAh",
            "name": "mybase",
            "revision": 1,
            "is_advanced": false,
            "time_zone": "Asia/Beijing",
            "formula_type": 1,
            "advance_version": "v1"
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
2001254000WrongRequestJson请求体错误
2001254001WrongRequestBody请求体错误
2001254002Fail导致报 1254002 错误码的场景较多，请参考以下建议排查： - 如果单次操作的内容变更较大，请尝试在单次操作中减少数据量 - 如果你并发调用了接口，请尝试控制请求间隔，稍后重试 - 如果在知识库（wiki）中创建多维表格，请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如，在分页查询多维表格时，传递了无效的 page_token，或传递了错误的数据表的 table_id - 如果该报错偶尔发生，可能是服务器超时或不稳定，请重试解决
2001254003WrongBaseTokenapp_token 错误。app_token 是多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： app_token.png - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。
2001254004WrongTableIdtable_id 错误。table_id 是多维表格数据表的唯一标识。获取方式： - 你可通过多维表格 URL 获取 table_id，下图高亮部分即为当前数据表的 table_id - 也可通过列出数据表接口获取 table_id
2001254005WrongViewIdview_id 错误。view_id 是多维表格中视图的唯一标识。获取方式： - 在多维表格的 URL 地址栏中，view_id 是下图中高亮部分： view_id.png - 通过列出视图接口获取。暂时无法获取到嵌入到云文档中的多维表格的 view_id。 注意： 当 filter 参数 或 sort 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 view_id 会被忽略。
2001254006WrongRecordIdrecord_id 错误。record_id 是数据表中一条记录的唯一标识。通过查询记录接口获取
2001254007EmptyValue空值
2001254008EmptyView空视图
2001254009WrongFieldIdfield_id 错误。field_id 是数据表中一个字段的唯一标识。通过列出字段接口获取
2001254010ReqConvError请求错误
2001254030TooLargeResponse响应体过大
4001254036Base is copying, please try again later.复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
2001254040BaseTokenNotFoundapp_token 不存在。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： app_token.png - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。
2001254041TableIdNotFoundtable_id 不存在。获取方式： - 你可通过多维表格 URL 获取 table_id，下图高亮部分即为当前数据表的 table_id - 也可通过列出数据表接口获取 table_id
2001254042ViewIdNotFoundview_id 不存在。获取方式： - 在多维表格的 URL 地址栏中，view_id 是下图中高亮部分： view_id.png - 通过列出视图接口获取。暂时无法获取到嵌入到云文档中的多维表格的 view_id。 注意： 当 filter 参数 或 sort 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 view_id 会被忽略。
2001254043RecordIdNotFoundrecord_id 不存在。record_id 是数据表中一条记录的唯一标识。请通过查询记录接口获取。
2001254044FieldIdNotFoundfield_id 不存在。field_id 是数据表中一个字段的唯一标识。通过列出字段接口获取。
2001254060TextFieldConvFail文本字段错误
2001254061NumberFieldConvFail数字字段错误
2001254062SingleSelectFieldConvFail单选字段错误
2001254063MultiSelectFieldConvFail多选字段错误
2001254064DatetimeFieldConvFail日期字段错误
2001254065CheckboxFieldConvFail复选框字段错误
2001254066UserFieldConvFail人员字段有误。原因可能是： - user_id_type 参数指定的 ID 类型与传入的 ID 类型不匹配 - 传入了不识别的类型或结构，目前只支持填写 id 参数，且需要传入数组 - 跨应用传入了 open_id。如果跨应用传入 ID，建议使用 user_id。不同应用获取的 open_id 不能交叉使用 - 若想对人员字段传空，可传 null
2001254067LinkFieldConvFail关联字段错误
2001254100TableExceedLimit数据表或仪表盘数量超限。每个多维表格中，数据表加仪表盘的数量最多为 100 个
2001254101ViewExceedLimit视图数量超限, 限制200个
2001254102FileExceedLimit文件数量超限
2001254103RecordExceedLimit记录数量超限, 限制20,000条
2001254104RecordAddOnceExceedLimit单次添加记录数量超限, 单次调用最多更新 1,000 条记录
2001254130TooLargeCell格子内容过大
2001254290TooManyRequest请求过快，稍后重试
2001254291Write conflict在同一个数据表中，并发调用了读写接口或请求过快，出现冲突。请参考以下建议解决： - 确保没有并发调用多维表格读写相关接口 - 若操作量较大，建议在接口与接口之间增加 0.5 或 1 秒的延迟，也可在报错中增加重试逻辑，确保业务的稳定性 - 对于写接口，可以将接口中的查询参数 ignore_consistency_check 设置为 true，表示在读写操作时，暂时忽略一致性检查，以提高性能
2001254301OperationTypeError多维表格未开启高级权限或不支持开启高级权限
2001255001InternalError内部错误，请联系技术支持
2001255002RpcError内部错误，请联系技术支持
2001255003MarshalError序列化错误，请联系技术支持
2001255004UmMarshalError反序列化错误，请联系技术支持
2001255005ConvError内部错误，请联系技术支持
5041255040Request timed out, please try again later请求超时，进行重试

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有