查询文档

... 2022-7-14 大约 2 分钟

# 查询文档

# 接口说明

本接口用于根据fileID进行查询,返回文档的信息。

# 权限说明

本接口需要拥有以下任意一项权限:

  • scope.drive.readonly
  • scope.drive.file.metadata
  • scope.drive.file.metadata.readonly

# 请求格式

描述 定义
Path /openapi/drive/v2/files/{fileID}/metadata
Method GET
Accept application/json

# 请求头部

详见Headers

# 请求参数

# 路径参数

参数名 类型 必选 描述
fileID string 文档唯一标识,详见fileID

# 查询参数

# 请求体

# 响应参数

# 请求体

参数名 类型 描述
ret integer 业务相应码
msg string 业务返回码描述
data json object 业务响应数据,详见文档元信息

# 请求包体

GET /openapi/drive/v2/files/300000000$AAAAAAAAAAAA/metadata HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Length: 0
1
2
3
4
5
6
1
2
3
4
5
6

# 示例

curl --location --request GET 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA/metadata' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
1
2
3
4
1
2
3
4

# 响应示例

{
    "ret": 0,
    "msg": "Succeed",
    "data": {
        "ID": "300000000$AAAAAAAAAAAA",
        "title": "exampleTitle",
        "type": "doc",
        "url": "https://docs.qq.com/doc/DAAAAAAAAAAAA",
        "status": "normal",
        "isCreator": true,
        "createTime": 1598245785,
        "creatorName": "张三",
        "isOwner": true,
        "ownerName": "张三",
        "lastModifyTime": 1602513117,
        "lastModifyName": "张三",
        "ownerID": "OWNER_ID"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 示例二

查询一个已经关联了表格的收集表的文件信息,回包里会携带关联的表格信息的信息。

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 3
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed', 'data': {'ID': '300000000$AAAAAAAAAAAA', 'title': 'exampleTitle', 'type': 'doc', 'url': 'https://docs.qq.com/doc/DAAAAAAAAAAAA', 'status': 'normal', 'isCreator': True, 'createTime': 1598245785, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1602513117, 'lastModifyName': '张三', 'ownerID': 'OWNER_ID'}}
1
2
3
4
5
6
7
1
2
3
4
5
6
7

# 错误码

错误码 错误说明 排查建议
10102 文件不存在 检查 fileID 参数是否正确,fileID 的获取方式见fileID

查询更多业务返回码

上次编辑于: 2023年5月31日 11:27
贡献者: mylochen , muyanyang , livlin