智能媒资托管查看指定空间收藏列表

功能描述 
查看指定空间收藏列表。
请求
请求示例
GET /api/v1/favorite/{LibraryId}/{SpaceId}/list?order_by=${OrderBy}&order_by_type=OrderByType&limit={Limit}&marker={Marker}&page={Page}&page_size={PageSize}&with_path={WithPath}&access_token={AccessToken}
请求参数
请求参数
描述
类型
是否必选
LibraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
SpaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(-)；如果媒体库为多租户模式，则必须指定该参数
String
是
Marker
用于顺序列出分页的标识
String
否
Limit
用于顺序列出分页时本地列出的项目数限制，默认为20
String
否
Page
分页码，默认第一页，不能与 marker 和 limit 参数同时使用
String
否
PageSize
分页大小，默认 20，不能与 marker 和 limit 参数同时使用
String
否
OrderBy
排序字段，按收藏时间排序为 favoriteTime（默认），目前仅支持按收藏时间排序
String
否
OrderByType
排序方式，升序为 asc，降序为 desc（默认）
String
否
WithPath
是否返回 path，返回为 true，不返回为 false（默认）
Boolean
否
AccessToken
访问令牌，获取请参见 生成访问令牌﻿
String
是
请求体
该请求无请求体。
响应
响应码
获取成功，返回 HTTP 200 OK。
响应体
application/json
响应体示例：
{
  "nextMarker": "CJS0ARABGAEiEzIwMjQtMTAtMjkgMTE6NDA6Mzg",
  "contents": {
        "spaceId": "spaceXXXXX",
        "type": "file",
        "creationTime": "2024-10-29T03:41:04.000Z",
        "modificationTime": "2024-10-29T03:41:05.000Z",
        "favoriteTime": "2024-10-29T03:41:05.000Z",
        "inode": "fe514XXXXXXXXX",
        "name": "XXXXXX",
        "fileType": "other",
        "size": "1024",
        "userId": "finn1234",
        "eTag": "\\"XXXXXXXXX-1\\"",
        "virusAuditStatus": 0,
        "path": [
          "XXXXXX"
        ],
        "category": "video",
        "labels": [
            "大象",
            "动物",
            "亚洲象"
        ],
        "contentType": "application/octet-stream",
        "crc64": "15171392718767694861",
        "previewByDoc": false,
        "previewByCI": false,
        "previewAsIcon": false,
        "removedByQuota": false,
        "metaData": {},
     }
}
响应体字段说明：
响应参数
描述
类型
nextMarker
用于顺序列出分页的标识，仅当使用marker、limit方式分页且当前不为最后一页时会返回
String
totalNum
用于表示收藏文件目录的总数，仅当使用page、pageSize方式分页时会返回
Int
contents
收藏的文件目录集合
Json
contents 中包含以下参数：
响应参数
描述
类型
spaceId
空间 ID
String
type
文件目录类型，如果文件已被删除，则不返回该字段，包含以下类型：
dir：目录或相簿
file：文件，仅用于文件类型媒体库
String
inode
文件或目录ID
String
name
文件或目录名称，如果文件已被删除，则返回空字符串
String
size
文件的大小，如果为目录则不返回该字段，如果文件已被删除，则不返回该字段
String
creationTime
文件或目录的创建时间，如果文件已被删除，则不返回该字段
String
modificationTime
文件最近一次被覆盖的时间，如果文件已被删除，则不返回该字段
String
favoriteTime
文件或目录的收藏时间
String
fileType
文件类型：Excel、PowerPoint 等，如果文件已被删除，则不返回该字段，如果为目录则不返回该字段
String
path
文件目录路径
String Array
userId
收藏人 ID
String
eTag
目录或文件的 eTag
String
virusAuditStatus
0-6 查毒状态，包含以下类型：
0 未检测 （文件夹不标记可疑状态，一直为0）
1 检测中
2 无风险
3 风险文件
4 无法检测 （比如文件太大超过可检测范围，端侧当无风险处理）（超1G不检）
5 人为标记为无风险
6 检测任务失败
Int
labels
文件标签数组
Array
category
自定义文件分类，比如 image、video、doc 等
String
contentType
媒体类型（仅非目录或相簿返回）
String
crc64
文件的 CRC64-ECMA182 校验值，为了避免数字精度问题，这里为字符串格式
String
previewByDoc
是否可通过 WPS 预览（仅非目录或相簿返回）
Boolean
previewByCI
是否可通过万象预览（仅非目录或相簿返回）
Boolean
previewAsIcon
是否可用预览图作为 icon（仅非目录或相簿返回）
Boolean
removedByQuota
是否因为配额超限而被删除文件（仅非目录或相簿返回）
Boolean
metaData
元数据（仅非目录或相簿返回）
Json
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

请求参数	描述	类型	是否必选
LibraryId	媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见创建媒体库	String	是
SpaceId	空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(-)；如果媒体库为多租户模式，则必须指定该参数	String	是
Marker	用于顺序列出分页的标识	String	否
Limit	用于顺序列出分页时本地列出的项目数限制，默认为20	String	否
Page	分页码，默认第一页，不能与 marker 和 limit 参数同时使用	String	否
PageSize	分页大小，默认 20，不能与 marker 和 limit 参数同时使用	String	否
OrderBy	排序字段，按收藏时间排序为 favoriteTime（默认），目前仅支持按收藏时间排序	String	否
OrderByType	排序方式，升序为 asc，降序为 desc（默认）	String	否
WithPath	是否返回 path，返回为 true，不返回为 false（默认）	Boolean	否
AccessToken	访问令牌，获取请参见生成访问令牌	String	是

响应参数	描述	类型
nextMarker	用于顺序列出分页的标识，仅当使用marker、limit方式分页且当前不为最后一页时会返回	String
totalNum	用于表示收藏文件目录的总数，仅当使用page、pageSize方式分页时会返回	Int
contents	收藏的文件目录集合	Json

查看指定空间收藏列表

本页目录：

功能描述

请求

请求示例

请求参数

请求体

响应

响应码

响应体

错误码