Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get global Ceph params

GET /provider/ceph

Returns settings global for the Ceph cluster.

Request Examples

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

Responses

application/json
200

The Ceph cluster configuration details.

Property
Type & Description
name
string

Name of the cluster.

fsid
string

Unique UUID of the cluster. Autogenerated when cluster is deployed if not specified.

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.

404

Ceph cluster not 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."
  }
}