Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get storage space usage details for specific OSD.

GET /provider/ceph/osds/{id}/usage

Returns storage space usage statistics of given Ceph OSD.

Path parameters

Parameter Type & Description
id required
string

The id of the OSD for usage check.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getCephOsdUsage id=3 --host https://$HOST:9443

Responses

application/json
200

The storage space usage information.

PropertyType & Description
total
integer

Total space (used and available) in bytes.

used
integer

Total used space in bytes.

available
integer

Total available space in bytes.

401

Unauthorized request.

403

Forbidden request.

404

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