Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get the report from a space auto-cleaning run

GET /provider/spaces/{id}/auto-cleaning/reports/{report_id}

Returns the details of a specific auto-cleaning run.

Path parameters

Parameter Type & Description
id required
string

The Id of a space.
report_id required
string

The Id of an auto-cleaning report.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE --host https://$HOST:9443 getProviderSpaceAutoCleaningReports id=$SPACE_ID report_id=$REPORT_ID

Responses

application/json
200

The report from a space auto-cleaning run.

PropertyType & Description
id
string

Id of an auto-cleaning report.

index
string

Index of an auto-cleaning report. It can be used to list report Ids starting from given report.

startedAt
string

Start time of an auto-cleaning run in ISO 8601 format.

stoppedAt
string

Finish time of an auto-cleaning run in ISO 8601 format.

releasedBytes
integer

Number of bytes deleted during an auto-cleaning run.

bytesToRelease
integer

Number of bytes that should be deleted.

filesNumber
integer

Number of deleted files.

status
string

Status of an auto-cleaning run.

Enum:
activecancellingcompletedfailedcancelled

Example

application/json
{
  "id": "asdfhLfgPDGSDFASDHgI",
  "index": "1290736458asdfhL",
  "startedAt": "2017-06-22T13:29:39.654Z",
  "stoppedAt": "2017-06-22T15:57:41.958Z",
  "releasedBytes": 60000,
  "bytesToRelease": 500,
  "filesNumber": 10,
  "status": "completed"
}
401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

PropertyType & Description
error
object

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."
  }
}