Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Ceph cluster health

GET /provider/ceph/status

Returns Ceph cluster health.

Request Examples

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

Responses

application/json
200

Ceph status report.

Property
Type & Description
level
string

General health status.

Enum:
ok warning error
messages
array of strings

List of Ceph status messages.

401

Unauthorized request.

403

Forbidden request.

404

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