tencent cloud

Continue Retrieving Search Results
Download PDF
Last updated: 2026-01-07 14:28:01
Continue Retrieving Search Results
Last updated: 2026-01-07 14:28:01
Download PDF

Description

Continue to get search results.

Request

Request Example

GET /api/v1/search/{LibraryId}/{SpaceId}/{SearchId}?marker={Marker}&access_token={AccessToken}&user_id={UserId}

Request Parameter

Request parameters.
Description
Type
Required or Not
LibraryId
Media Library ID, obtained after creating a media library in the Media Hosting console. Please refer to Create Media Library.
String
Yes
SpaceId
Space ID, you must specify this parameter. If the media library is in single-tenant mode, this parameter is fixed as hyphen (-).
String
Yes
SearchId
Search task ID, see Search directory and file
String
Yes
Marker
pagination identifier, the nextMarker field returned when creating a search task or continuing to retrieve search results, see Create a Search Task
String
Yes
AccessToken
Access token, see Generate Access Token
String
Yes
UserId
User identity recognition is used to temporarily designate user identity when the access token corresponds to admin permission and user identity recognition during token application is empty. For details, see Generate Access Token API.
String
No

Request Body

This request does not have a request body.

Response

Response code

Successful retrieval, return HTTP 200 OK.

Response Body

application/json
Response body example:
{
    "searchId": "FnMwV3NweXJOU2hTOTRpTnF0TW9EZVEeVUFhYUl5TGFSaTZtZUpDcEpUcEtxdzo3NjQ3NjU1",
    "searchFinished": true,
    "hasMore": true,
    "nextMarker": 20,
    "contents": [
        {
            "type": "file",
            "inode": "xx11",
            "name": "api.zip",
            "creationTime": "2021-08-19T04:40:01.000Z",
            "modificationTime": "2021-08-19T04:40:01.000Z",
            "contentType": "application/zip",
            "size": "67084",
            "eTag": "\\"52c2d19d61fae57d11caabe87f71de73\\"",
            "isFavorite": true,
            "crc64": "8970780629994048831",
            "versionId":2,
            "metaData": {
                "x-smh-meta-creation-date": "Thu, 19 Aug 2021 04:39:59 GMT"
            },
            "path": ["api.zip"],
            "userId": "12",
            "localCreationTime": "2020-09-22T07:44:45.000Z",
            "localModificationTime": "2020-09-22T07:44:45.000Z"
        },
        {
            "type": "file",
            "inode": "xx12",
            "name": "bmw (1).PDF",
            "creationTime": "2021-08-21T07:56:32.000Z",
            "modificationTime": "2021-08-21T07:56:32.000Z",
            "contentType": "application/pdf",
            "size": "241674",
            "eTag": "\\"030ca96f0af3b3d3cfbf31c2be3129d6\\"",
            "isFavorite": false,
            "crc64": "12098979488941977387",
            "metaData": {
                "x-smh-meta-creation-date": "Sat, 21 Aug 2021 07:56:30 GMT"
            },
            "path": ["abc", "bmw (1).PDF"],
            "userId": "12",
            "localCreationTime": "2020-09-22T07:44:45.000Z",
            "localModificationTime": "2020-09-22T07:44:45.000Z"
        },
        {
            "type": "file",
            "inode": "xx111",
            "name": "bmw.pdf",
            "creationTime": "2021-08-17T13:19:07.000Z",
            "modificationTime": "2021-08-17T13:19:07.000Z",
            "contentType": "application/pdf",
            "size": "241674",
            "eTag": "\\"030ca96f0af3b3d3cfbf31c2be3129d6\\"",
            "isFavorite": false,
            "crc64": "12098979488941977387",
            "metaData": {
                "x-smh-meta-creation-date": "Tue, 17 Aug 2021 13:19:06 GMT"
            },
            "path": ["abc", "bmw.pdf"],
            "userId": "12",
            "localCreationTime": "2020-09-22T07:44:45.000Z",
            "localModificationTime": "2020-09-22T07:44:45.000Z"
        },
        {
            "type": "dir",
            "inode": "bbb",
            "name": "fysn",
            "creationTime": "2021-08-20T10:01:40.000Z",
            "modificationTime": "2021-08-21T07:30:25.000Z",
            "path": ["fysn"],
            "userId": "12",
            "isFavorite": false
        },
        {
            "type": "file",
            "inode": "123333",
            "name": "Smart Media Hosting-144px (1).png",
            "creationTime": "2021-08-20T09:59:25.000Z",
            "modificationTime": "2021-08-20T09:59:25.000Z",
            "contentType": "image/png",
            "size": "7199",
            "eTag": "\\"7d9ce6ef46c00d3924702b7b4224d029\\"",
            "isFavorite": true,
            "crc64": "13076174829147183381",
            "metaData": {
                "x-smh-meta-creation-date": "Fri, 20 Aug 2021 09:59:22 GMT"
            },
            "path": ["fysn", "SMH-144px (1).png"],
            "previewByDoc": true,
            "previewByCI": true,
            "previewAsIcon": true,
            "fileType": "powerpoint",
            "userId": "12",
            "localCreationTime": "2020-09-22T07:44:45.000Z",
            "localModificationTime": "2020-09-22T07:44:45.000Z",       
            "authorityList": {
                "canView": true,
                "canPreview": true,
                "canDownload": true,
                "canPrint": true,
                "canUpload": true,
                "canDelete": true,
                "canModify": true,
                "canAuthorize": true,
                "canShare": true,
                "canPreviewSelf": true,
                "canDownloadSelf": true
            },
            "authorityButtonList": {
                "showViewButton": true,
                "showPreviewButton": true,         
                "showDownloadButton": true,
                "showUploadButton": true,
                "showDeleteButton": true,
                "showAuthorizeButton": true,
                "showShareButton": true,
                "showModifyButton": true,
                "showMoveButton": true,
                "showRenameButton": true,
                "showCopyButton": true,
                "showRestoreButton": true     
            }
        }
        /* ... */
    ]
}
Response body field description:
Response Parameters
Description
Type
searchId
Search task ID for asynchronously fetching search result
String
searchFinished
whether the search has been completed
Boolean
hasMore
whether there is more search result
Boolean
nextMarker
Pagination identifier to obtain subsequent pages, returned only when hasMore is true
Int
contents
The search result on the first page may be an empty array. For details about async search, see [API description].
Int
The contents include:
Response Parameters
Description
Type
type
Entry type, supports the following types:
dir: directory or album;
file: file, only used for file type media library;
image: image, only used for media type library;
video: video, only used for media type library;
symlink: symbolic link;
String
inode
File directory ID
String
name
Directory or album name or file name
Boolean
creationTime
ISO 8601 formatted date and time string, representing the creation time of a directory or album or the upload time of a file, for example: 2020-10-14T10:17:57.953Z
String
modificationTime
The last time the file was overwritten, or the last time subdirectories or files were added or removed in the directory
String
contentType
media type
String
versionId
Version number.
String
size
File size, in string format to avoid digit precision issues
String
isFavorite
boolean value, whether it is a favorite, returned when WithFavoriteStatus = 1
Boolean
eTag
file eTag
String
crc64
The CRC64-ECMA182 check value of the file, in string format to avoid digit precision issues
String
metaData
file metadata information
Object
path
The directory where the current project resides, including the project name
String
userId
Creator/Updater User ID
String
previewByDoc
whether WPS can preview
Boolean
previewByCI
whether Wanxiang can preview
Boolean
previewAsIcon
whether preview image can be used as icon
Boolean
fileType
File type: Excel, PowerPoint, etc.
String
labels
Simplified file tag
String Array
category
Custom file categories, such as image, video, doc
String
localCreationTime
Local creation time of the file
String
localModificationTime
Local modification time of the file
String
authorityList
Permission list
Array
authorityButtonList
Button permission list
Array
authorityList contains the following parameters:
Response Parameters
Description
Type
canView
Whether viewable
Boolean
canPreview
Previewable
Boolean
canDownload
Downloadable
Boolean
canPrint
Whether printable
Boolean
canUpload
Uploadable
Boolean
canDelete
Deletable or Not
Boolean
canModify
Whether editable
Boolean
canAuthorize
Authorizable or not
Boolean
canShare
Shareable
Boolean
canPreviewSelf
Previewable
Boolean
canDownloadSelf
Downloadable
Boolean
authorityButtonList contains the following parameters:
Response Parameters
Description
Type
showViewButton
Display view button
Boolean
showPreviewButton
Display preview button
Boolean
showDownloadButton
Display download button
Boolean
showUploadButton
Display upload button
Boolean
showDeleteButton
Display delete button
Boolean
showAuthorizeButton
Display authorization button
Boolean
showShareButton
Display share button
Boolean
showModifyButton
Display edit button
Boolean
showMoveButton
Display mobile button
Boolean
showRenameButton
Display rename button
Boolean
showCopyButton
Display copy button
Boolean
showRestoreButton
Display recovery button
Boolean

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