Skip to content

获取文件信息

适用版本>=v7.0.2404b.20240425

接口说明:获取文件元信息

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/meta
请求方法GET
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求应用身份管理文档(应用授权) kso.appfile.readwrite

请求头(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位
file_idstring文件id,长度不超过1024位

查询参数(Query)

名称类型是否必填说明
with_permissionboolean是否返回文件操作权限(应用文档:忽略此参数)
with_linkboolean是否返回文件分享信息(应用文档:忽略此参数)
with_ext_attrsboolean是否返回文件扩展属性(应用文档:忽略此参数)
with_driveboolean是否返回文件所属drive信息

响应体(Response)

名称类型说明
dataobject
created_byobject创建者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
ctimeinteger创建时间,时间戳,单位为秒
driveobject驱动盘信息
allotee_idstring盘归属的应用id,长度不超过1024位
allotee_typestring盘归属身份类型,固定为app
company_idstring企业id(应用文档:忽略此参数)
created_byobject创建者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
ctimeinteger创建时间,时间戳,单位为秒
descriptionstring盘描述
ext_attrsobject[]盘扩展属性
namestring名称
valuestring
idstring驱动盘id
mtimeinteger修改时间,时间戳,单位为秒
namestring驱动盘名称
permission_modestringEnum: "builtin" "callback",权限校验模式
quotaobject[]盘容量(应用文档:返回-1)
deletedinteger回收站中的文件占用的总空间,以字节为单位。只读。
remaininginteger剩余的总空间,以字节为单位。只读。
totalinteger允许的总存储空间,以字节为单位。只读。
usedinteger已使用的总空间,以字节为单位。只读。
sourcestring盘来源,应用文档:appfile
statusstringEnum: "inuse" "deleted",盘状态
storage_modestringEnum: "tree" "kv",驱动盘组织结构
drive_idstring驱动盘id
idstring文件id
link_idstring链接id(应用文档:忽略此参数)
link_urlstring链接url(应用文档:忽略此参数)
modified_byobject修改者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
mtimeinteger修改时间,时间戳,单位为秒
namestring文件名
parent_idstring父目录id(应用文档:0)
sharedboolean是否开启分享(应用文档:false)
sizeinteger文件大小
typestringEnum: "folder" "file" "shortcut",文件类型(应用文档:file)
versioninteger文件版本号
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

{
  "data": {
    "created_by": {
      "id": "string",
      "type": "sp"
    },
    "ctime": 0,
    "drive": {
      "allotee_id": "string",
      "allotee_type": "app",
      "company_id": "string",
      "created_by": {
        "id": "string",
        "type": "sp"
      },
      "ctime": 0,
      "description": "string",
      "ext_attrs": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "id": "string",
      "mtime": 0,
      "name": "string",
      "permission_mode": "callback",
      "quota": {
        "deleted": -1,
        "remaining": -1,
        "total": -1,
        "used": -1
      },
      "source": "string",
      "status": "inuse",
      "storage_mode": "kv"
    },
    "drive_id": "string",
    "id": "string",
    "link_id": "string",
    "link_url": "string",
    "modified_by": {
      "id": "string",
      "type": "sp"
    },
    "mtime": 0,
    "name": "string",
    "parent_id": "string",
    "shared": false,
    "size": 0,
    "type": "file",
    "version": 0
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}