Skip to content
API Reference
/
Cloud Storage
/
/Cloud Storage Files

Page Cloud Storage Files

Request

List Cloud Storage files, page by page.

  • Effect: none. Read-only. Safe to retry with bounded backoff.
  • Visibility: only files whose upload was confirmed are listed — a file with a pre-signed URL that was never completed does not appear. Members without the all-data permission see only files they uploaded.
  • Filtering: fileName matches partially; tagIds is an OR match; results are ordered newest first and the order cannot be changed.
  • Caveat: an entry in tagInfo can be null when a tag was deleted while still attached to the file.
Bodyapplication/jsonrequired
pageNointeger, >= 1

Current page number, starting from 1. Default is 1.

Default:1
Example:1
pageSizeinteger, >= 1

Number of items per page. Default is 10.

Default:10
Example:20
fileNamestring

File name keyword for fuzzy search.

Example:"report"
tagIdsArray of strings

Filter files by tag IDs.

Example:
[
  "1800000000000101"
]
fileTypeinteger

File type filter: 0 = image, 1 = video, 2 = application, 3 = audio, 4 = document, 5 = other.

Example:0
fileIdsArray of strings

Filter files by file IDs.

Example:
[
  "1800000000001001"
]
POST
/api/cloudstorage/file/page
curl -i -X POST \
  http://127.0.0.1:40000/api/cloudstorage/file/page \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 1,
    "pageSize": 20,
    "fileName": "report",
    "tagIds": [
      "1800000000000001"
    ]
  }'

Responses

Success

Bodyapplication/json
codeintegerrequired

Return result code. 0 means success; other codes indicate exceptions.

Example:0
msgstring or nullrequired

Error message.

Example:null
requestIdstring

Operation request ID. This field may be present when the request passes through the API gateway.

Example:"1d4f3ea968664593860b94b35d4ebf5e"
dataobject(FilePageData)required
Response
{
  "code": 0,
  "msg": null,
  "requestId": "1d4f3ea968664593860b94b35d4ebf5e",
  "data": {
    "current": "1",
    "pages": "7",
    "total": "128",
    "dataList": [ … ]
  }
}