列举收藏文件信息 - listStarFile

功能介绍

列举收藏文件信息接口，每次返回最大支持100个。

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/star/files

表1 Query参数
参数	是否必选	参数类型	描述
pageSize	否	Integer	参数解释：分页个数约束限制：不涉及取值范围： <=100 默认取值： 100
pageCursor	否	String	参数解释：游标，由前一个响应的nextCursor获取约束限制：不涉及取值范围：不涉及默认取值：不涉及
sortType	否	Integer	参数解释：排序类型约束限制：不涉及取值范围：收藏时间（默认）默认取值：1
sortDirection	否	Integer	参数解释：排序方向型约束限制：不涉及取值范围： 1：升序，2：降序（默认）默认取值： 2
fileType	否	String	参数解释：文件类型约束限制：不涉及取值范围： 10：文件夹 11：智能文件夹（该功能目前只有白名单用户使用） 15：图片 20：视频 26：word 27：excel 28：ppt 30：音频 35：压缩文件 40：应用 45：其他默认取值：不涉及
imageProcess	否	String	参数解释：缩略图尺寸约束限制：不涉及取值范围：取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 默认取值： image/resize,m_lfit,h_128,w_128

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	参数解释：该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} 约束限制：不涉及取值范围：不涉及默认值：不涉及
X-Traceid	否	String	参数解释：业务跟踪id（必须58位）约束限制：不涉及取值范围：长度为58位默认值：不涉及
language	否	String	参数解释：国际化语言标识约束限制：符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语取值范围：符合i18n规范默认取值： en-US
X-User-Id	是	String	参数解释： KooDrive侧用户id，用于app鉴权约束限制：不涉及取值范围：不涉及默认值：不涉及
X-Date	是	String	参数解释：日期，用于app鉴权，格式为yyyyMMdd‘T’HHmmss‘Z’ 约束限制：距当前时间15分钟以内，不能晚于当前时间取值范围：不涉及默认值：不涉及

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
nextCursor	String	分页游标，如果不存在，代表已返回最后一个
autoDeleted	Integer	自动删除的文件数量（原文件已被物理删除）
starFileList	Array of StarFile objects	收藏文件信息
code	String	响应码
msg	String	响应信息

表4 StarFile
参数	参数类型	描述
id	String	文件id
fileName	String	文件名，最长250个字符
fileType	String	文件类型，外部输入
mimeType	String	内容类型
favorite	Boolean	文件是否被收藏
recycled	Boolean	文件是否被放入回收站
parentFolder	Array of strings	父目录ID列表，注意：当前只取第一个父母Id
properties	Map<String,String>	文件公共自定义属性。key-value个数不能超过30个；单个key-value长度不超过124字符
containers	Array of strings	空间标识
createdTime	String	文件创建时间
editedTime	String	文件修改时间
owners	Array of owners objects	拥有者
lastEditor	lastEditor object	最后编辑者
fileSuffix	String	文件后缀，fullFileExtension最后一个字符串
size	Integer	文件大小
sha256	String	文件的sha256
attachments	Array of attachments objects	附件（用途，附件），只有风控服务appid返回
downloadLinks	Array of DownloadLink objects	FileProxy文件列表下载地址
userProperties	userProperties object	用户属性
starredTime	String	收藏时间
filePath	String	文件位置，只记录到团队名称
spaceType	String	空间类型： 1：个人空间 2：团队空间 3：回收站 4：无权访问空间
invalid	Integer	文件是否已失效，0：正常，1：失效
hidden	Boolean	文件是否隐藏
userCapabilities	userCapabilities object	用户权限

表5 owners
参数	参数类型	描述
category	String	类型，drive#user
userId	String	华为用户ID
me	Boolean	是否是我
permissionId	String	权限id

表6 lastEditor
参数	参数类型	描述
category	String	类型，drive#user
userId	String	华为用户ID
me	Boolean	是否是我
permissionId	String	权限id

表7 attachments
参数	参数类型	描述
usage	String	用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段
hash	String	Asset关联的资源的hash
sha256	String	Asset关联的资源的sha256
asset	asset object	资产

表8 asset
参数	参数类型	描述
resource	resource object	资源

表9 resource
参数	参数类型	描述
objects	Array of SliceObject objects	分片对象，适用于type={0,3}

**表10** SliceObject
参数	参数类型	描述
id	String	分片ID
start	Long	分片的起始位置，不适用于type={12}
downloadUrl	downloadUrl object	下载url
images	Array of Images objects	缩略图

**表11** downloadUrl
参数	参数类型	描述
url	String	URL
method	String	http method

**表12** Images
参数	参数类型	描述
process	String	文件资源名称
downloadUrl	EndpointURLMetadata object	文件上传或下载的URL结构

**表13** EndpointURLMetadata
参数	参数类型	描述
url	String	URL
method	String	http method

**表14** DownloadLink
参数	参数类型	描述
usage	String	用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段
downloadLink	String	附件下载地址

**表15** userProperties
参数	参数类型	描述
properties	Map<String,String>	扩展属性（不限单个属性长度，限制总大小为16K以内）

**表16** userCapabilities
参数	参数类型	描述
addChildNodePermission	Boolean	是否可以增加子目录/文件
copyPermission	Boolean	是否可以拷贝
deletePermission	Boolean	是否可以删除
downloadPermission	Boolean	是否可以下载内容
editPermission	Boolean	是否可以编辑
listChildNodePermission	Boolean	是否可以list子目录/文件
removeChildNodePermission	Boolean	是否可以移动子目录
renameFilePermission	Boolean	是否可以重命名
shareFilePermission	Boolean	是否可以共享
uploadPermission	Boolean	是否可以上传文件
viewPermission	Boolean	是否可以预览

请求示例

按照收藏时间降序排列每页100个收藏文件并按照规定代销显示缩略图

GET /koodrive/ose/v1/star/files?pageSize=100&sortDirection=2&sortType=1&imageProcess=image/resize,m_lfit,h_128,w_128%3Bimage/resize,m_lfit,h_480,w_480%3Bimage/resize,m_lfit,h_800,w_800%3Bimage/resize,m_lfit,h_1080,w_1080&tenantId=667706171d1c4ef2a4d7464f3656066c

Authorization: Bearer+f19b0*********1421be9c

响应示例

状态码：200

{
  "starFileList": [
    {
      "id": "Fo*********A",
      "fileName": "眼巴巴.jpg",
      "favorite": true,
      "starredTime": "2025*********Z",
      "mimeType": "image/jpeg",
      "fileSuffix": "jpg",
      "recycled": false,
      "hidden": false,
      "size": 2058,
      "parentFolder": [
        "DFkaJ_Mm*********77"
      ],
      "containers": [
        "I*********77"
      ],
      "properties": {
        "path": "rootI*********WA",
        "localCreatedAt": "",
        "localUpdatedAt": "",
        "auditResult": "{\"auditDetail\":\"{}\",\"auditLevel\":10,\"auditResult\":1}"
      },
      "sha256": "938c32*********8a506029",
      "attachments": [
        {
          "asset": {
            "resource": {
              "object": {
                "id": "002*********86",
                "start": 0,
                "downloadUrl": {
                  "url": "https://*********",
                  "method": "GET"
                },
                "images": [
                  {
                    "process": "image/resize,m_lfit,h_128,w_128",
                    "downloadUrl": {
                      "url": "https://*********",
                      "method": "GET"
                    }
                  }
                ]
              }
            }
          },
          "hash": "938c*********029",
          "usage": "content",
          "sha256": "938c*********029"
        }
      ],
      "owners": [
        {
          "category": "dr*********r",
          "me": true,
          "permissionId": "160*********76",
          "userId": "ZWU*********M0NA"
        }
      ],
      "lastEditor": {
        "category": "drive#user",
        "me": true,
        "permissionId": "160*********76",
        "userId": "ZWU*********M0NA"
      },
      "fileType": "15",
      "createdTime": "2025-*********Z",
      "editedTime": "2025-*********Z",
      "userProperties": {
        "attributes": {
          "starred": "false"
        },
        "properties": {
          "hidden": "false"
        }
      },
      "downloadLinks": [
        {
          "usage": "content",
          "downloadLink": "https://*********"
        },
        {
          "usage": "thumbnail",
          "downloadLink": "https://*********"
        }
      ],
      "userCapabilities": {
        "addChildNodePermission": true,
        "copyPermission": true,
        "deletePermission": true,
        "downloadPermission": true,
        "editPermission": true,
        "listChildNodePermission": true,
        "removeChildNodePermission": true,
        "renameFilePermission": true,
        "shareFilePermission": true,
        "uploadPermission": true,
        "viewPermission": true
      },
      "creatingUser": "ZWU*********M0NA",
      "filePath": "个人空间",
      "invalid": 0,
      "spaceType": "1"
    },
  ],
  "autoDeleted": 0,
  "code": 0,
  "msg": "成功"
}

状态码

状态码	描述
200	OK

父主题：文件收藏

上一篇：批量收藏文件接口 - batchStarFile

下一篇：分享管理-我分享的

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试