Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get provider cluster nodes IPs

GET /provider/cluster_ips

Returns IPs of nodes in provider cluster.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getProviderClusterIps --host https://$OP_PANEL_HOST:9443

Responses

application/json
200

The IPs of provider nodes.

Property
Type & 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.

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