获取文件信息
适用版本>=v7.0.2307b.20230720
接口说明:获取文件信息
请求说明
| 请求地址 | 配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 以用户身份管理文档(用户授权) kso.drive.as_user.manage 更新文件(用户授权) kso.file.write 应用查询文件(应用授权) kso.appdrive.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} |
路径参数(Path)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 驱动盘id,<= 1024 characters |
| file_id | string | 是 | 文件(夹)id,<= 1024 characters |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| with_permission | bool | 否 | 是否返回文件操作权限 |
| with_ext_attrs | bool | 否 | 是否返回文件扩展属性 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ id | string | 文件id,<= 1024 characters |
| ∟ drive_id | string | 驱动盘id,<= 1024 characters |
| ∟ parent_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:用户 |
| ∟ 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 | 文件名称,<= 1024 characters |
| ∟ ctime | int64 | 文件创建时间,时间戳,单位为秒 |
| ∟ mtime | int64 | 文件修改时间,时间戳,单位为秒 |
| ∟ hash | object | 文件哈希信息 |
| ∟ ∟ sum | string | 哈希结果 |
| ∟ ∟ type | string | 哈希类型,固定为s2s |
| ∟ ext_attrs | object[] | 文件扩展属性。若没有拓展属性,则不返回ext_attrs。 |
| ∟ permission | object | 文件权限 |
| ∟ link_url | string | 分享链接,<= 1024 characters |
| ∟ link_id | string | 分享链接id,<= 1024 characters |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
{
"code": 0,
"data": {
"id": "190553624936448",
"drive_id": "2",
"mtime": 1688958714,
"hash": {
"type": "s2s",
"sum": "zLkaKwSAHdEqLch701q4SG1nkQhOUJ4ZSgMnbsT1tuI="
},
"link_url": "https://10.13.80.140/path3/path4/weboffice/l/slKU2imdd7Af",
"link_id": "slKU2imdd7Af",
"permission": {
"list": true,
"preview": true,
"rename": true,
"share": true,
"move": true,
"delete": true,
"perm_ctl": true,
"copy_content": true,
"print": true,
"download": true,
"copy": true,
"comment": true,
"update": true,
"new_empty": true,
"upload": true
},
"parent_id": "0",
"created_by": {
"id": "1",
"name": "admin",
"avatar": "https://10.13.80.140/path3/path4/avatar/api/v1/custom_avatar/ZGVmYXVsdC9zMnMvS0hFNlFNWUZDQlRJU1NSNUVQN0JYM0dZMlJFQllHSFNOWEo2MkhSUjZSV1dIUUs1SUlEQS82ZThlZGY5MjgwLzIyMzE=",
"company_id": "1",
"type": "user"
},
"modified_by": {
"id": "1",
"name": "admin",
"avatar": "https://10.13.80.140/path3/path4/avatar/api/v1/custom_avatar/ZGVmYXVsdC9zMnMvS0hFNlFNWUZDQlRJU1NSNUVQN0JYM0dZMlJFQllHSFNOWEo2MkhSUjZSV1dIUUs1SUlEQS82ZThlZGY5MjgwLzIyMzE=",
"company_id": "1",
"type": "user"
},
"size": 5743045,
"version": 21,
"type": "file",
"name": "文字文稿.docx",
"ctime": 1688543049
},
"detail": "",
"msg": "ok"
}