Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

List user's clusters

GET /user/clusters

Lists clusters to which current user belongs.

Request Examples

Shell

onepanel-rest-cli getClusters --host https://$HOST:9443 -H "x-auth-token: $TOKEN"

Responses

application/json

200

List of cluster ids.

Property	Type & Description
ids array of strings List of ids.

Example

application/json

{
  "ids": [
    "26cbc2b20f92416eb9f3cba65e50c1d2",
    "9ad94a9296d145a1a2b894f5fd7f48b0",
    "95ad2c09508f47198635e46a6ea4d005"
  ]
}

400

Invalid request.

Property

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

403

Forbidden request.

404

Request client is not a Onezone member.

500

Internal server error.

Property

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