Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get zone cluster configuration

GET /zone/configuration

Returns the zone cluster configuration.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getZoneConfiguration --host https://$HOST:9443

Responses

application/json

200

The zone cluster configuration.

Property

Type & Description

cluster

object (ClusterConfigurationDetails)

The cluster configuration.

master required

string

Host responsible for deploying cluster and coordinating cluster restarts.

hosts required

array of strings

List of hosts belonging to the Onepanel cluster.

databases required

object (DatabaseHosts)

The cluster database service hosts configuration.

hosts required

array of strings

The list of service hosts.

managers required

object (ManagerHosts)

The cluster manager service hosts configuration.

mainHost required string The main cluster manager host. Main cluster manager node is responsible for monitoring cluster worker nodes. Other nodes, which are redundant, are suspended. In case of main cluster manager node failure one of redundant nodes is resumed and takes over main node responsibilities.
hosts required array of strings The list of service hosts.

workers required

object (WorkerHosts)

The cluster worker service hosts configuration.

hosts required

array of strings

The list of service hosts.

onezone

object

The zone custom configuration.

domainName required string Onezone's domain.
name required string The name of a zone.
configured required boolean True if all steps of cluster deployment and configuration have been performed.

Example

application/json

{
  "cluster": {
    "master": "node1.onezone.onedata.example.com",
    "managers": {
      "mainHost": "node1.onezone.onedata.example.com",
      "hosts": [
        "node1.onezone.onedata.example.com"
      ]
    },
    "workers": {
      "hosts": [
        "node1.onezone.onedata.example.com"
      ]
    },
    "databases": {
      "hosts": [
        "node1.onezone.onedata.example.com"
      ]
    }
  },
  "onezone": {
    "domainName": "example.com",
    "name": "example",
    "configured": true
  }
}

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.

409

Cluster already deployed.

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