Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get status of space auto-cleaning mechanism

GET /provider/spaces/{id}/auto-cleaning/status

Returns status of current process of auto-cleaning for the space.

Path parameters

Parameter Type & Description
id required
string

The Id of a space.

Request Examples

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

Responses

application/json
200

Information about current auto-cleaning process for the space.

PropertyType & Description
inProgress
boolean

Flag which indicates whether auto-cleaning process is currently in progress

spaceOccupancy
integer

Amount of storage [b] used by data from given space on that storage.

Example

application/json
{
  "inProgress": true,
  "spaceOccupancy": 100200
}
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."
  }
}
503

Services needed to fulfill this request are not running.