获取常用列表
适用版本>=v7.0.2406a.20240613
接口说明:获取常用列表
请求说明
| 请求地址 | 配置域名+/graph+/v7/drive_freq/items |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 更新文件(用户授权) kso.file.write 查询文件(用户授权) kso.file.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| with_permission | bool | 否 | 是否返回文件操作权限 |
| page_size | int | 是 | 请求大小 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果;当查询结果中next_page_token为空或无该返回值时,代表无下一页。 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | |
| ∟ items | object[] | 数据集合,<= 1024 items |
| ∟ ∟ ctime | int | 创建时间 |
| ∟ ∟ position | int | 列表排序位置 |
| ∟ ∟ drive | object | 文件存储的介质 |
| ∟ ∟ ∟ allotee_id | string | 盘归属身份idallotee_type=user,allotee_id代表用户id;allotee_type=group,allotee_id代表用户组id |
| ∟ ∟ ∟ allotee_type | string | 盘归属身份类型,可选值: user:用户 group:用户组 |
| ∟ ∟ ∟ company_id | string | 企业id,<= 1024 characters |
| ∟ ∟ ∟ created_by | object | 创建者 |
| ∟ ∟ ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ∟ ∟ ctime | int | 创建时间,时间戳,单位为秒 |
| ∟ ∟ ∟ description | string | 盘描述,<= 1024 characters |
| ∟ ∟ ∟ ext_attrs | object[] | 盘扩展属性,<= 1024 items |
| ∟ ∟ ∟ ∟ name | string | 属性名,<= 1024 characters |
| ∟ ∟ ∟ ∟ value | string | 属性值,<= 1024 characters |
| ∟ ∟ ∟ id | string | <= 1024 characters |
| ∟ ∟ ∟ mtime | int | 修改时间,时间戳,单位为秒 |
| ∟ ∟ ∟ name | string | 驱动盘名称,<= 1024 characters |
| ∟ ∟ ∟ quota | object | 盘容量 |
| ∟ ∟ ∟ ∟ deleted | int | 回收站中的文件占用的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ ∟ remaining | int | integer [int64]剩余的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ ∟ total | int | 允许的总存储空间,以字节为单位。只读。 |
| ∟ ∟ ∟ ∟ used | int | 已使用的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ status | string | 盘状态inuse:使用中 deleted: 已删除 |
| ∟ ∟ ∟ source | string | 盘来源 |
| ∟ ∟ file | object | 文件属性 |
| ∟ ∟ ∟ id | string | 文件id |
| ∟ ∟ ∟ drive_id | string | 驱动盘id |
| ∟ ∟ ∟ parent_id | string | 父文件id |
| ∟ ∟ ∟ created_by | object | 创建者信息 |
| ∟ ∟ ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ∟ ∟ modified_by | object | 修改者信息 |
| ∟ ∟ ∟ ∟ avatar | string | 修改者头像,<= 1024 characters |
| ∟ ∟ ∟ ∟ company_id | string | 修改者企业id,<= 1024 characters |
| ∟ ∟ ∟ ∟ id | string | 修改者id,<= 1024 characters |
| ∟ ∟ ∟ ∟ name | string | 修改者名称,<= 1024 characters |
| ∟ ∟ ∟ ∟ type | string | 修改者身份类型,user:用户 |
| ∟ ∟ ∟ size | int64 | 文件大小 |
| ∟ ∟ ∟ version | int | 文件版本 |
| ∟ ∟ ∟ type | string | 文件类型 |
| ∟ ∟ ∟ name | string | 文件名称 |
| ∟ ∟ ∟ ctime | int64 | 文件创建时间,时间戳,单位为秒 |
| ∟ ∟ ∟ mtime | int64 | 文件修改时间,时间戳,单位为秒 |
| ∟ ∟ ∟ hash | object | 文件哈希信息 |
| ∟ ∟ ∟ ∟ sum | string | 哈希结果 |
| ∟ ∟ ∟ ∟ type | string | 哈希类型,固定为s2s |
| ∟ ∟ ∟ ext_attrs | object[] | 文件扩展属性 |
| ∟ ∟ ∟ permission | object | 文件权限 |
| ∟ ∟ ∟ link_url | string | 分享链接 |
| ∟ ∟ ∟ link_id | string | 分享链接id |
| ∟ ∟ file_src | object | 文件来源 |
| ∟ ∟ ∟ name | string | 来源名称,<= 1024 characters |
| ∟ ∟ ∟ type | string | 来源类型,Enum: "link" "user_private" "user_roaming" "group_normal" "group_dept" "group_whole" |
| ∟ ∟ object_type | string | 常用对象类型,Enum: "file" "drive" |
| ∟ next_page_token | string | 下一页分页标记,<= 1024 characters;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
响应体示例
{
"data": {
"items": [
{
"ctime": 0,
"position": 0,
"drive": {
"allotee_id": "string",
"allotee_type": "user",
"company_id": "string",
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"ctime": 0,
"description": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"mtime": 0,
"name": "string",
"quota": {
"deleted": 0,
"remaining": 0,
"total": 0,
"used": 0
},
"status": "inuse"
},
"file": {
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"ctime": 0,
"drive_id": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"hash": {
"sum": "string",
"type": "s2s"
},
"id": "string",
"link_id": "string",
"link_url": "string",
"modified_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"mtime": 0,
"name": "string",
"parent_id": "string",
"permission": {
"comment": true,
"copy": true,
"copy_content": true,
"delete": true,
"download": true,
"list": true,
"move": true,
"new_empty": true,
"perm_ctl": true,
"preview": true,
"print": true,
"rename": true,
"share": true,
"update": true,
"upload": true
},
"size": 0,
"type": "folder",
"version": 0
},
"file_src": {
"name": "string",
"type": "link"
},
"object_type": "file"
}
],
"next_page_token": "string"
},
"code": 0,
"detail": "string",
"msg": "string"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103