Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get cluster details

GET /clusters/{id}

Returns the details about a specific cluster.

This operation requires membership in the cluster or oz_clusters_view admin privilege.

Example cURL requests

Get cluster details

curl -u admin:password -X GET \
https://$ZONE_HOST/api/v3/onezone/clusters/$CLUSTER_ID

{
  "clusterId": "f8d843beda24e54545455ecc0f4b8886",
  "type": "oneprovider",
  "workerVersion": {
    "release": "25.1",
    "build": "1-gfabf02d",
    "gui": "129c549fbe9b3e730c3d9910492228566e39e1236945766a74381405cc57fb04"
  },
  "onepanelVersion": {
    "release": "25.1",
    "build": "3-89fc6bad",
    "gui": "68e7e1472adb719ddf2d88908775091dfb10e5d0b916f06125ea1af4056044e3"
  },
  "online": true,
  "onepanelProxy": false,
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

Path parameters

Parameter	Type & Description
id required	string Cluster Id.

Request Examples

Shell

onezone-rest-cli getCluster id=b752ceafabb662b4e5728b2ded25cdd1

Responses

application/json

200

Information about a cluster.

Property

Type & Description

clusterId

string

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

type

string

Type of the cluster

Enum:

oneprovider onezone

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).

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type

string

Type of the subject

Enum:

nobody user oneprovider

string

Id of the subject (null for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "clusterId": "2c0160248ba9a66f45da751ca459535a",
  "type": "oneprovider",
  "workerVersion": {
    "release": "25.1",
    "build": "1-gfabf02d",
    "gui": "68e7e1472adb719ddf2d88908775091dfb10e5d0b916f06125ea1af4056044e3"
  },
  "onepanelVersion": {
    "release": "25.1",
    "build": "1-gd76fac2",
    "gui": "5d9dd608775091dfb10ef2d888e7e14720b916f06125ea1af4056044eadb7193"
  },
  "onepanelProxy": true,
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

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

401

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

403

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

404

Resource not found.

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

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