tencent cloud

View Specified Space Favorite List
Download PDF
Last updated:2026-01-07 14:52:08
View Specified Space Favorite List
Last updated: 2026-01-07 14:52:08
Download PDF

Description

View specified space favorite list.

Request

Request Example

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}

Request Parameter

Request parameters.
Description
Type
Required or Not
LibraryId
Media Library ID, obtained after creating a media library in the media hosting console, see create media library
String
Yes
SpaceId
Space ID. If the media library is in single-tenant mode, this parameter is fixed as a hyphen (-); if the media library is in multi-tenant mode, you must specify this parameter.
String
Yes
Marker
Identifier for sequential page listing
String
No
Limit
Limit on the number of locally listed projects for sequential pagination, default is 20
String
No
Page
Pagination code, default first page, cannot be used with the marker and limit parameters simultaneously
String
No
PageSize
Page size, default 20, cannot be used with the marker and limit parameters simultaneously
String
No
OrderBy
Sorting field, sorted by favoriteTime (default), currently only support sorting by favorite time
String
No
OrderByType
Sorting method, ascending as asc, descending as desc (default)
String
No
WithPath
Whether to return the path, true for return, false for no return (default)
Boolean
No
AccessToken
Access token, see Generate Access Token
String
Yes

Request Body

This request has no request body.

Response

Response code

Successfully obtained, returning HTTP 200 OK.

Response Body

application/json
Response body example:
{
  "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": [
            "elephant"
            "animal",
            "Asian elephant"
        ],
        "contentType": "application/octet-stream",
        "crc64": "15171392718767694861",
        "previewByDoc": false,
        "previewByCI": false,
        "previewAsIcon": false,
        "removedByQuota": false,
        "metaData": {},
     }
}
Response body field description:
Response Parameters
Description
Type
nextMarker
Identifier for sequential page listing, returned only when using marker and limit method to paginate and not on the last page.
String
totalNum
Total number of favorite file directories, returned only when using page and pageSize method to paginate.
Int
contents
Collection of favorite file directories
Json
The contents include the following parameters:
Response Parameters
Description
Type
spaceId
Space ID
String
type
File directory type. If the file is deleted, this field is not returned. Supported types:
dir: directory or album
file: file, only used for file type media library
String
inode
File or directory ID
String
name
File or directory name. If the file is deleted, return an empty string.
String
size
File size. If it is a directory, this field is not returned. If the file is deleted, this field is not returned.
String
creationTime
Creation time of the file or directory. If the file is deleted, this field is not returned.
String
modificationTime
Last overwritten time of the file. If the file is deleted, this field is not returned.
String
favoriteTime
Favorite time of the file or directory
String
fileType
File type: Excel, PowerPoint. If the file is deleted, this field is not returned. If it is a directory, this field is not returned.
String
path
File directory path
String Array
userId
Favorite User ID
String
eTag
Directory or file eTag
String
virusAuditStatus
0-6 Virus scan status, including the following types:
0 not detected (folders are not tagged as suspicious and remain 0)
detecting
2 risk-free
3 risk file
4 Unable to detect (such as when the file is too large, exceeding the detection range, treated as risk-free on the client side) (files over 1GB are not scanned)
5 Marked with manual no risk
6 Failed detection task
Int
labels
file tag array
Array
category
Custom file categories, such as image, video, doc
String
contentType
media type (only returned for non-directory or non-album)
String
crc64
CRC64-ECMA182 check value of the file, to avoid number accuracy issues, here in string format
String
previewByDoc
Whether previewable via WPS (only returned for non-directory or non-album)
Boolean
previewByCI
Whether previewable via Wanxiang (only returned for non-directory or non-album)
Boolean
previewAsIcon
Whether the preview image can be used as icon (only returned for non-directory or non-album)
Boolean
removedByQuota
Whether files were deleted because quota exceeded (only returned for non-directory or non-album)
Boolean
metaData
metadata (only returned for non-directory or non-album)
Json

Error Codes

This request operation has no special error messages. For common error messages, see Error Codes.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback