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 pool.

GET /provider/ceph/pools/{name}/usage

Returns storage space usage statistics of given Ceph pool.

Path parameters

Parameter Type & Description
name required
string

The name of the pool for usage check.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getCephPoolUsage name=$POOL_NAME --host https://$HOST:9443

Responses

application/json
200

The data usage information.

PropertyType & Description
used
integer

Total size of objects in the pool in bytes.

maxAvailable
integer

Projected size in bytes of data which may be written to the pool. See "Checking a Cluster’s Usage Stats" in the Ceph documentation.

401

Unauthorized request.

403

Forbidden request.

404

The Ceph pool 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."
  }
}