Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Ceph monitor

GET /provider/ceph/monitors/{id}

Returns details of a Ceph monitor instance.

Path parameters

Parameter Type & Description
id required
string

Id of the Ceph monitor to describe.

Request Examples

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

Responses

application/json
200

Ceph monitor specification.

PropertyType & Description
host
string

Host on which given monitor should be deployed. There may be only one monitor per host. Attempts at creating additional monitors at the same host will be ignored.

ip
string

Local IP to be used for communication between Ceph nodes. If not specified it will be autodetected.

id
string

Monitor identifier. Equal to the hostname of the node where monitor is deployed.

401

Unauthorized request.

403

Forbidden request.

404

Ceph monitor with given id does not exist.

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