Skip to content

获取常用列表

适用版本>=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_permissionbool是否返回文件操作权限
page_sizeint请求大小
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果;当查询结果中next_page_token为空或无该返回值时,代表无下一页。

响应体(Response)

名称类型说明
codeinteger错误码
detailstring详细信息
msgstring状态信息
dataobject
itemsobject[]数据集合,<= 1024 items
ctimeint创建时间
positionint列表排序位置
driveobject文件存储的介质
allotee_idstring盘归属身份idallotee_type=user,allotee_id代表用户id;allotee_type=group,allotee_id代表用户组id
allotee_typestring盘归属身份类型,可选值: user:用户 group:用户组
company_idstring企业id,<= 1024 characters
created_byobject创建者
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
ctimeint创建时间,时间戳,单位为秒
descriptionstring盘描述,<= 1024 characters
ext_attrsobject[]盘扩展属性,<= 1024 items
namestring属性名,<= 1024 characters
valuestring属性值,<= 1024 characters
idstring<= 1024 characters
mtimeint修改时间,时间戳,单位为秒
namestring驱动盘名称,<= 1024 characters
quotaobject盘容量
deletedint回收站中的文件占用的总空间,以字节为单位。只读。
remainingintinteger [int64]剩余的总空间,以字节为单位。只读。
totalint允许的总存储空间,以字节为单位。只读。
usedint已使用的总空间,以字节为单位。只读。
statusstring盘状态
inuse:使用中
deleted: 已删除
sourcestring盘来源
fileobject文件属性
idstring文件id
drive_idstring驱动盘id
parent_idstring父文件id
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文件名称
ctimeint64文件创建时间,时间戳,单位为秒
mtimeint64文件修改时间,时间戳,单位为秒
hashobject文件哈希信息
sumstring哈希结果
typestring哈希类型,固定为s2s
ext_attrsobject[]文件扩展属性
permissionobject文件权限
link_urlstring分享链接
link_idstring分享链接id
file_srcobject文件来源
namestring来源名称,<= 1024 characters
typestring来源类型,Enum: "link" "user_private" "user_roaming" "group_normal" "group_dept" "group_whole"
object_typestring常用对象类型,Enum: "file" "drive"
next_page_tokenstring下一页分页标记,<= 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"
}