Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get information about auto storage import scan

GET /provider/spaces/{id}/storage-import/auto/info

Returns information about current or last finished auto storage import scan.

Path parameters

Parameter Type & Description
id required
string

The Id of a space for which storage import stats should be returned.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE --host https://$OP_PANEL_HOST:9443 getAutoStorageImportInfo id=$SPACE_ID

Responses

application/json
200

Information of auto storage import mechanism in given space.

Property
Type & Description
status
string

Describes status of current (or last finished) auto storage import scan in given space.

Enum:
enqueued running aborting completed failed aborted
start
integer

Time at which current (or last finished) scan has been started.

stop
integer

Time at which current (or last finished) scan has been stopped.

createdFiles
integer

Counter of created files (both directories and regular files) that has been detected during current (or last finished) scan.

modifiedFiles
integer

Counter of modified files (both directories and regular files) that has been detected during current (or last finished) scan.

deletedFiles
integer

Counter of deleted files (both directories and regular files) that has been detected during current (or last finished) scan.

unmodifiedFiles
integer

Counter of unmodified files (both directories and regular files) that has been detected during current (or last finished) scan.

failedFiles
integer

Counter of files (both directories and regular files) for which the processing has failed during current (or last finished) scan.

nextScan
integer

Estimated time at which next scan will be enqueued.

totalScans
integer

Total number of performed scans.

Example

application/json
{
  "status": "done",
  "start": 1598871401,
  "stop": 1598871427,
  "createdFiles": 1146,
  "modifiedFiles": 191,
  "deletedFiles": 303,
  "unmodifiedFiles": 1350,
  "failedFiles": 1,
  "nextScan": 1598871487
}
401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

Property
Type & Description
error
object (ErrorDetails)

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
503

Services needed to fulfill this request are not running.