获取分享链接信息
适用版本>=v7.0.2402.20240222
接口说明:获取分享链接信息
请求说明
| 请求地址 | 配置域名+/graph+/v7/links/{link_id}/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 管理文件分享(用户授权) kso.file.share.write 应用查询文件分享(应用授权) kso.appdrive.file.share.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| link_id | string | 是 | 链接id,<= 1024 characters |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 链接元数据 |
| ∟ creator | object | 创建者身份 |
| ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ drive_id | string | 盘id,<= 1024 characters |
| ∟ file_id | string | 文件id,<= 1024 characters |
| ∟ id | string | 分享id,<= 1024 characters |
| ∟ mtime | integer | 修改时间,时间戳,单位为秒 |
| ∟ opts | object | 链接设置 |
| ∟ ∟ allow_perm_apply | bool | 允许申请权限 |
| ∟ ∟ check_code | string | 访问密码 |
| ∟ ∟ close_after_expire | bool | 过期后取消分享链接 |
| ∟ ∟ expire_period | integer | Enum: 0 7 30,过期时长 |
| ∟ ∟ expire_time | integer | 过期时间点 |
| ∟ role_id | string | 链接权限角色id |
| ∟ scope | string | 链接权限范围,users: 仅指定人;company:本企业内 |
| ∟ status | string | 链接状态,open:开启;closed:关闭;expired:过期 |
| ∟ url | string | 分享访问url |
响应体示例
{
"data": {
"creator": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"ctime": 0,
"drive_id": "string",
"file_id": "string",
"id": "string",
"mtime": 0,
"opts": {
"allow_perm_apply": true,
"check_code": "string",
"close_after_expire": true,
"expire_period": 0,
"expire_time": 0
},
"role_id": "string",
"scope": "anyone",
"status": "open",
"url": "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
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