Search Image Files

Search image files in a tenant.

Request URL

POST {base_url}/uc-cautop/api/v1/image-files/search-page

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
pageNumber Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
keyword No String The keyword used to search for image files. The keyword fuzzy matches the name, file name, remark, assigned reseller email, or assigned tenant code.
sorts No Array<Sort_Condition> The sort conditions. If omitted, the result is sorted by creation time in descending order.
Sort_Condition
Parameter Required Type Description
property No String The name of the field to sort by. - name - file_name - remark
direction No String The sort order: - asc: Sort in ascending order. - desc: Sort in descending order.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Search_Result> The search result of image files.
Search_Result
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
count Integer The total number of image files that match the search conditions.
limit Integer The maximum number of image files that can be created.
remaining Integer The number of image files that can still be created.
results Array<Image_File_Item> The list of matching image files.
Image_File_Item
Parameter Type Description
id String The unique identifier of the image file.
name String The name of the image file.
fileName String The original file name of the image file.
fileSize String The size of the file, in bytes.
remark String The remark of the image file.
createdAt String The time when the image file was created, in Unix timestamp format (seconds).
updatedAt String The time when the image file was last updated, in Unix timestamp format (seconds).
ownerType String The owner type of the image file: - admin: Administrator. - reseller: Reseller.
ownerEmail String The email address of the owner's primary account.
ownerDisplay String The display name of the owner, which is assembled according to the role of the current user and the ownership of the resource, for example Admin / user@email.com.
assignedResellers Array<String> The email addresses of the assigned resellers. This parameter is visible to administrators only, and is empty for resellers and tenants.
assignedTenants Array<String> The codes of the assigned tenants. This parameter is visible to administrators and resellers only, and is empty for tenants.

Example

Request example

POST /uc-cautop/api/v1/image-files/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3MDY4NiwiaWF0IjoxNzkwNzQ5MDg2LCJqdGkiOiIyNjQ5ZTk2Yi1kZjBkLTQ3ZjItOTJlNS01ODEyYTg4NmJjOWQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.0wcK9nXqw2qECw8dH5sEp68buMqqDyWsqKIZ6uaXBPF1OAcywjSbIw4jCtll7s9cfsXh8iO0n1dVb90yh5eepg2g7YxI-BibZLFG68qGdCLT2wjaSS1AjvXfL10fkdLfTopn_9Ie9XrW_5C6k1p02hea_q5tEqTWM23ICVKnhXo3J6pSYUHWnKfwJCk3UqEQBu1bc5lTLCH-Sa096FrwtNuNfynyHK5WHcmopYio5fNGggplSQKrAXjrw4azV6VF4E6EPoMszj_cS68zACNDNdZW4kj6gF0Ui5A60UZ_7N3n9sczLv4Ico4sKxC9SnRv1cXlmbO_18piJejxI_3T8g
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "2a1f48ebd7c18ee275dbe7f382bf5f5c",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": 0,
    "limit": 20,
    "remaining": 20,
    "results": []
  }
}