获取文件夹元数据
该接口用于根据文件夹 token 获取该文件夹的元数据,包括文件夹的 ID、名称、创建者 ID 等。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/explorer/v2/folder/:folderToken/meta |
| HTTP Method | GET |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive.metadata:readonly 查看云空间中文件元数据 |
Tip: 了解更多权限相关信息,参考云文档常见问题。
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 应用调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,参考选择并获取访问凭证。 值格式:"Bearer access_token" 可选值如下: - tenant_access_token: 以应用身份调用 API,可读写的数据范围由应用自身的数据权限范围决定。参考自建应用获取 tenant_access_token或商店应用获取 tenant_access_token。示例值:"Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234" - user_access_token: 以用户身份调用 API,可读写的数据范围由用户的的数据权限范围决定。参考获取 user_access_token。。示例值:"Bearer u-cjz1eKCEx289x1TXEiQJqAh5171B4gDHPq00l0GE1234" |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
folderToken | string | 是 | 文件夹 token。了解如何获取文件夹 token,参考文件夹概述。 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
id | string | 文件夹的 ID |
name | string | 文件夹的标题 |
token | string | 文件夹的 token |
createUid | string | 文件夹的创建者 ID |
editUid | string | 文件夹的最后编辑者 ID |
parentId | string | 文件夹的上级目录 ID。“0” 表示当前文件夹无上级目录 |
ownUid | string | 文件夹为个人文件夹时,为文件夹的所有者 ID;文件夹为共享文件夹时,为文件夹树 ID |
响应体示例
json
{
"code": 0,
"msg": "Success",
"data": {
"id": "7110173013420512356",
"name": "name",
"token": "nodbcbHUdOsS613xVzTzFEabcef",
"createUid": "7103496998321312356",
"editUid": "7103496998321312356",
"parentId": "0",
"ownUid": "7110173013420512356"
}
}错误码
以下为本接口相关错误码。了解其它通用错误码,参考通用错误码。
| 错误码 | 说明 | 排查建议 |
|---|---|---|
| 91201 | FAILED | 处理失败。请稍后重试。 |
| 91203 | not found | 参数错误。请检查路径参数是否正确。 |
| 91204 | FORBIDDEN | 当前应用或用户没有权限。参考本文档“请求”部分的权限要求为应用或用户开启对应权限。了解更多,参考云空间常见问题。 |
