Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Ceph storage space usage.

GET /provider/ceph/usage

Returns summary of storage space usage in the Ceph cluster.

Request Examples

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

Responses

application/json
200

The usage statistics.

Property
Type & Description
total
object (DataUsage)

Describes storage space usage level.
total required
integer

Total space (used and available) in bytes.

used required
integer

Total used space in bytes.

available required
integer

Total available space in bytes.

osds
object

Dictionary of OSDs with associated usage data.

pools
object

Dictionary of pools with associated usage data.

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