Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get space details

GET /provider/spaces/{id}

Returns details of space specified by space Id in the path.

Example cURL requests

Get space details

curl -H "X-Auth-Token: $TOKEN" -X GET https://$OP_PANEL_HOST/api/v3/onepanel/provider/spaces/$SPACE_ID

{
    "supportingProviders": {
        "03c7e42a793912307b01b1bbb72a3a6bch4c1c": 10000000
    },
    "storageId": "18a42a43b1b2d92455ffa09e9a15df7fch4f82",
    "spaceOccupancy": 0,
    "name": "someSpace",
    "localStorages": ["18a42a43b1b2d92455ffa09e9a15df7fch4f82"],
    "importedStorage": false,
    "id": "16403a6c45105010dc7103e31874cb3echac41",
    "accountingEnabled": false,
    "dirStatsServiceEnabled": true,
    "dirStatsServiceStatus": "initializing"
}

Path parameters

Parameter	Type & Description
id required	string The Id of a space which details should be returned.

Request Examples

Shell

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

Responses

application/json

200

The space details.

Property Type & Description

string

The Id of the space.

name

string

The name of the space.

storageId

string

Id of storage that supports this space on provider that is associated with this panel.

localStorages

array of strings

The list of IDs of cluster storage resources.

supportingProviders

object

The collection of provider IDs with associated supported storage space in bytes.

storageImport

object (StorageImport)

Configuration of the storage import within the space.

mode

string

Mode of the storage import within the space.

In case of auto mode, the storage will be automatically scanned and data will be imported from storage into the assigned Onedata space without need for copying the data.

Configuration of the auto storage import can be passed in the autoStorageImportConfig parameter. It is possible to enable periodical scans for automatic detection of changes on the storage (refer to the option continuousScan in the config).

In case of manual mode, the files must be registered manually by the space users with REST API. Registration of directories is not supported. For more info please read: https://onedata.org/#/home/api/stable/oneprovider?anchor=tag/File-registration

Enum:

automanual

autoStorageImportConfig

object (AutoStorageImportConfig)

Configuration of auto storage import mechanism. The auto import is based on scans - gradual traversing of the file system and registration of files and directories.

maxDepth integer Maximum depth of filesystem tree that will be traversed during the scan.
syncAcl boolean Flag that enables synchronization of NFSv4 ACLs.
continuousScan boolean With this option enabled the storage will be scanned periodically and direct changes on the storage will be reflected in the assigned Onedata space (upon the consecutive scan).
scanInterval integer Period between subsequent scans in seconds (counted from end of one scan till beginning of the following). This parameter is relevant only for continuous scans.
detectModifications boolean Flag determining that modifications of files on the synchronized storage will be detected. If disabled, the storage will be treated as immutable (only creations and deletions of files on storage will be detected). This parameter is relevant only for continuous scans.
detectDeletions boolean Flag determining that deletions of files from the synchronized storage will be detected. This parameter is relevant only for continuous scans.

spaceOccupancy

integer

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

accountingEnabled

boolean

Indicates if accounting is enabled. The accounting mechanism utilizes directory statistics to keep track of quota usage within a space for the corresponding supporting provider.

dirStatsServiceEnabled

boolean

Indicates if the directory statistics service is enabled. The service gathers statistics concerning logical and physical directory size, file count and update times. It cannot be disabled if accounting is enabled.

dirStatsServiceStatus

string

Current status of directory statistics service.

Enum:

initializingenabledstoppingdisabled

401

Unauthorized request.

403

Forbidden request.

404

Space does not exist or is not supported by the provider.

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.