Skip to content

Query Folder Information API

API Information

  • Request Path: /datafile/query/folder/info
  • Request Method: GET
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token

Request Parameters

ParameterTypeRequiredDescriptionConstraints
dirPathStringYesDirectory pathMust be a valid directory path

Parameter Example

/datafile/query/folder/info?dirPath=/data/satellite

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataFolderInfoFolder information response

DataFolderInfo Object

FieldTypeDescription
allFilesSizeDoubleTotal size of all files in GB
filesCountIntegerTotal number of files in the folder

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "allFilesSize": 25.6,
    "filesCount": 25
  }
}

Failure Response

json
{
  "code": 404,
  "message": "Folder not found",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
404Folder not found
500Server internal error

Usage Instructions

  1. This API is used to query additional information about a folder
  2. User authentication is required
  3. Directory path must be provided as query parameter
  4. Returns folder statistics including file counts, sizes, and subdirectories

Notes

  • Directory path is required and must be a valid directory
  • Returns comprehensive folder statistics
  • Useful for folder management and analysis
  • User authentication token must be included in request headers