Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Get zone cluster nodes IPs

GET /zone/cluster_ips

Returns IPs of nodes in zone cluster.

Request Examples

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

Responses

application/json
200

The IPs of zone nodes.

PropertyType & Description
isConfigured
boolean

If true, user has already sent a request updating IPs thus marking them as accepted.

hosts
object

The collection of cluster nodes associated with their IPs.

401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

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

Services needed to fulfill this request are not running.