Skip to content

File Page Query ​

Paginated file query, supports searching by file name, MD5, and other criteria, returns paginated results.

Interface Address:

text
/papi/file/page

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 hash
X-TimestampstringYesMillisecond Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10-32 lowercase alphanumeric characters

Body Parameters:

ParameterTypeRequiredDescription
pageNointegerNoPage number, starting from 1, default 1
pageSizeintegerNoNumber of items per page, maximum 1000, default 10
namestringNoSearch criteria (sid, name, md5)
typeintegerNoFile type

Request Example:

json
{
    "pageNo": 1,
    "pageSize": 10
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectResponse data
├─ listarray[object]File list
├─├─ namestringApplication name
├─├─ urlstringURL
├─├─ pathstringPath
├─├─ sizeintegerFile size
├─├─ md5stringFile MD5 value
├─├─ ctimeintegerCreation time
├─├─ utimeintegerUpdate time
├─├─ versionstringVersion
├─├─ logostringApplication icon
├─├─ packageNamestringPackage name
├─├─ suffixstringSuffix
├─├─ ossPathstringOSS path
├─├─ rootOfficeIdintegerTeam ID
├─ totalintegerTotal count
msgstringError message

Response Example:

json
{
    "code": 0,
    "data": {
        "list": [
            {
                "name": "",
                "url": "",
                "path": "",
                "size": 0,
                "md5": "",
                "ctime": 0,
                "utime": 0,
                "version": "",
                "logo": "",
                "packageName": "",
                "suffix": "",
                "ossPath": "",
                "rootOfficeId": 0
            }
        ],
        "total": 0
    },
    "msg": ""
}

OpenAPI Docs