Skip to content

获取文件信息

适用版本>=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_idstring驱动盘id,<= 1024 characters
file_idstring文件(夹)id,<= 1024 characters

查询参数(Query)

名称参数类型是否必填说明
with_permissionbool是否返回文件操作权限
with_ext_attrsbool是否返回文件扩展属性

响应体(Response)

名称类型说明
dataobject
idstring文件id,<= 1024 characters
drive_idstring驱动盘id,<= 1024 characters
parent_idstring父文件(夹)id,<= 1024 characters
created_byobject创建者信息
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
modified_byobject修改者信息
avatarstring修改者头像,<= 1024 characters
company_idstring修改者企业id,<= 1024 characters
idstring修改者id,<= 1024 characters
namestring修改者名称,<= 1024 characters
typestring修改者身份类型,user:用户
sizeint64文件大小
versionint文件版本
typestring文件类型
namestring文件名称,<= 1024 characters
ctimeint64文件创建时间,时间戳,单位为秒
mtimeint64文件修改时间,时间戳,单位为秒
hashobject文件哈希信息
sumstring哈希结果
typestring哈希类型,固定为s2s
ext_attrsobject[]文件扩展属性。若没有拓展属性,则不返回ext_attrs。
permissionobject文件权限
link_urlstring分享链接,<= 1024 characters
link_idstring分享链接id,<= 1024 characters
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

{
    "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"
}