Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get details of a user's cluster

GET /user/clusters/{id}

Returns details of the specified cluster.

Path parameters

Parameter Type & Description
id required
string

Cluster Id which details should be returned.

Request Examples

Shell
onepanel-rest-cli getCluster --host https://$PANEL_HOST:9443 -H "x-auth-token: $TOKEN"

Responses

application/json
200

Information about the cluster.

Property
Type & Description
id
string

Id of the cluster record.

type
string

Type of the cluster.

Enum:
oneprovider onezone
serviceId
string

The Id of the service hosted on this cluster - depending on the type equal to the Oneprovider Id or "onezone" in case of Onezone cluster

workerVersion
object (VersionInfo)

Service version info.
release required
string

Release version.

build required
string

Build number.

gui required
string

GUI version indicated by a SHA256 hash.

onepanelVersion
object (VersionInfo)

Service version info.
release required
string

Release version.

build required
string

Build number.

gui required
string

GUI version indicated by a SHA256 hash.

onepanelProxy
boolean

Is Onepanel proxy enabled - if so, onepanel GUI is served on cluster's domain at port 443 (rather than 9443).

400

Invalid request.

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

Forbidden request.

404

Request client is not member of cluster with given Id.

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