# 列举收藏文件信息 - listStarFile #### 功能介绍 列举收藏文件信息接口，每次返回最大支持100个。 #### 授权信息 当前API调用无需身份策略权限。 #### URI GET /koodrive/ose/v1/star/files 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pageSize | 否 | Integer | 每个返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 | | pageCursor | 否 | String | 当前页游标，由前一个响应的nextCursor获取 | | sortType | 否 | Integer | 排序类型，1：收藏时间（默认） | | sortDirection | 否 | Integer | 排序方向，1：升序，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 | | usage | 否 | String | 文档、视频缩略图格式；取值范围为 minThumbnail,midThumbnail,largeThumbnail,superLargeThumbnail | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Authorization | 是 | String | 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} | | X-Traceid | 否 | String | 消息日志跟踪标识（必须58位） | | X-User-Id | 是 | String | 用户id，用于app鉴权 | | X-Date | 是 | String | 日期，用于app鉴权 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | nextCursor | String | 分页游标，如果不存在，代表已返回最后一个 | | autoDeleted | Integer | 自动删除的文件数量（原文件已被物理删除） | | starFiles | Array of [StarFileInfo] objects | 收藏文件信息 | | code | String | 响应码 | | msg | String | 响应信息 | 表4StarFileInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 类型，drive#file | | id | String | 文件id | | fileName | String | 文件名，最长250个字符 | | fileType | String | 文件类型，外部输入 | | mimeType | String | 内容类型 | | favorite | Boolean | 文件是否被收藏 | | recycled | Boolean | 文件是否被放入回收站 | | parentFolder | Array of strings | 父目录ID列表，注意：当前只取第一个父母Id | | properties | Map\ | 文件公共自定义属性。key-value个数不能超过30个；单个key-value长度不超过124字符 | | containers | Array of strings | 空间标识 | | createdTime | String | 文件创建时间 | | editedTime | String | 文件修改时间 | | editedByMe | Boolean | 是否是我修改文件 | | owners | Array of [User] objects | 拥有者 | | lastEditor | [User] object | 最后编辑者 | | fullFileSuffix | String | 完整的文件后缀，取name第一个.后的字符串 | | fileSuffix | String | 文件后缀，fullFileExtension最后一个字符串 | | size | Integer | 文件大小 | | sha256 | String | 文件的sha256 | | attachments | Array of [Attachment] objects | 附件（用途，附件），只有风控服务appid返回 | | downloadLinks | Array of [DownloadLink] objects | FileProxy文件列表下载地址 | | userProperties | [PrivateProperties] object | 用户属性 | | starredTime | String | 收藏时间 | | filePath | String | 文件位置，只记录到团队名称 | | spaceType | String | 空间类型： - 1：个人空间 - 2：团队空间 - 3：回收站 - 4：无权访问空间 | | invalid | Integer | 文件是否已失效，0：正常，1：失效 | | hidden | Boolean | 文件是否隐藏 | | userCapabilities | [userCapabilities] object | 用户权限 | 表5User | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 类型，drive#user | | userId | String | 华为用户ID | | displayName | String | 用户显示名 | | me | Boolean | 是否是我 | | permissionId | String | 权限id | 表6Attachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | usage | String | 用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段 | | assetId | String | Asset ID | | length | Long | 文件大小 | | versionId | String | Asset版本ID | | mimeType | String | MIME类型 | | hash | String | Asset关联的资源的hash | | sha256 | String | Asset关联的资源的sha256 | | createdTime | String | 数据创建时间 | | modifiedTime | String | 数据最后修改时间 | | attributes | Map\ | 类型属性 | | asset | [Asset] object | 资产 | 表7Asset | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | Asset ID | | versionId | String | Asset版本ID | | version | Long | 版本号 | | mimeType | String | MIME type | | keepPolicy | Integer | 历史版本的保存策略 - 0：自动清理，保留两个版本，第三个版本时淘汰最早的（目的是为了防止并发场景下获取失败） - 1：永久保存 | | state | Integer | 数据的状态 - 0：可用 - 1：不可用 - 2：临时 - 3：留存（不可飞速） - 4：待割接 | | createdTime | String | 数据创建时间 | | modifiedTime | String | 数据最后修改时间 | | lastModifyingUser | String | 最后一次修改的用户UPID | | resource | [Resource] object | 资源 | | cipher | [Cipher] object | 密码器 | | attributes | Map\ | 类型属性（Key部分使用字母开头的字母加数字组合，Value部分禁止使用emoji字符，不限单个属性长度，限制总大小为16K以内），存在字段如下： - pictureMetadata：图片属性数据，参见PictureMetadata定义 - videoMetadata：视频属性数据，参见VideoMetadata定义 - audioMetadata：音频属性数据，参见AudioMetadata定义 - contentDisposition：下载附件未指定response-content-disposition，自动使用该字段填充（resource.type=12生效） | | properties | Map\ | 扩展属性 | 表8Resource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 文件资源ID | | hash | String | 文件资源的hash | | length | Long | 文件资源的长度 | | sha256 | String | 文件的sha256（用于完整性校验） | | type | Integer | 资源类型 - 0：密文分片文件 - 3：明文分片文件 - 12：明文单片文件 | | state | Integer | 数据的状态 - 0：可用 - 1：不可用 - 2：临时 - 3：留存（不可飞速） - 4：待割接 | | sliceSize | Long | 分片大小 | | hfek | String | 加密文件的fek的hash，用于type={0} | | iv | String | 加密文件的IV，适用于type={0} | | createdTime | String | 数据创建时间 | | modifiedTime | String | 数据最后修改时间 | | objects | Array of [SliceObject] objects | 分片对象，适用于type={0,3} | | attributes | Map\ | 类型属性 | | properties | Map\ | 扩展属性 | 表9SliceObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 分片ID | | number | Integer | 分片序号，从0开始计，不适用于type={12} | | start | Long | 分片的起始位置，不适用于type={12} | | sha256 | String | 分片的sha256（如果是加密，是指密文的sha256） | | length | Long | 分片的长度（如果是加密，则是密文长度） | | bucket | String | OBS桶信息 | | createdTime | String | 数据创建时间 | | modifiedTime | String | 数据最后修改时间 | | uploadUrl | [EndpointURL] object | 上传url | | downloadUrl | [EndpointURL] object | 下载url | | uploadId | String | 分段上传ID，适用于type={12}且uploadMode=multipart | | attributes | Map\ | 类型属性 | | properties | Map\ | 扩展属性 | | images | Array of [Images] objects | 缩略图 | 表10EndpointURL | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | URL | | method | String | http method | | headers | Map\ | http headers | | forms | Map\ | 表单参数，适用于type={12}且uploadMode=post | | partId | String | 分段参数，适用于type={12}且uploadMode=multipart | 表11Images | 参数 | 参数类型 | 描述 | |:---|:---|:---| | process | String | 文件资源名称 | | downloadUrl | [EndpointURLMetadata] object | 文件上传或下载的URL结构 | 表12EndpointURLMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | URL | | method | String | http method | 表13Cipher | 参数 | 参数类型 | 描述 | |:---|:---|:---| | algorithm | String | 加密算法 | | hfek | String | 加密文件的fek的hash，用于type={0,4} | | iv | String | 加密文件的IV，适用于type={0,4} | | dataType | Integer | 数据类型 - 11：同步盘 | | keychains | Array of [Keychain] objects | 钥匙串 | 表14Keychain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | key的UUID | | type | Integer | 密钥类型 - 1：efek - 2：zfek - 3：sfek | | algorithm | String | 加密算法 | | ekey | String | 加密后的key | 表15DownloadLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | usage | String | 用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段 | | downloadLink | String | 附件下载地址 | | version | Integer | 附件版本号 | 表16PrivateProperties | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attributes | Map\ | 类型属性（不限单个属性长度，限制总大小为16K以内） | | properties | Map\ | 扩展属性（不限单个属性长度，限制总大小为16K以内） | 表17userCapabilities | 参数 | 参数类型 | 描述 | |:---|:---|:---| | addChildNodePermission | Boolean | 是否可以增加子目录/文件 | | copyPermission | Boolean | 是否可以拷贝 | | deletePermission | Boolean | 是否可以删除 | | downloadPermission | Boolean | 是否可以下载内容 | | editPermission | Boolean | 是否可以编辑 | | listChildNodePermission | Boolean | 是否可以list子目录/文件 | | removeChildNodePermission | Boolean | 是否可以移动子目录 | | renameFilePermission | Boolean | 是否可以重命名 | | shareFilePermission | Boolean | 是否可以共享 | | uploadPermission | Boolean | 是否可以上传文件 | | viewPermission | Boolean | 是否可以预览 | #### 请求示例 无 #### 响应示例 无 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK |