Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List Ceph pools

GET /provider/ceph/pools

Returns object containing list of Ceph pool details.

Request Examples

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

Responses

application/json
200

The pools details.

PropertyType & Description
pools
array of objects (CephPool)

List of Ceph pools.

name
string

Name of the pool.

copiesNumber
integer

Desired number of object replicas in the pool. When below this number the pool still may be used in 'degraded' mode. Defaults to 2 if there are at least 2 OSDs, 1 otherwise.

minCopiesNumber
integer

Minimum number of object replicas in the pool. Below this threshold any I/O for the pool is disabled. Must be lower or equal to 'copiesNumber'. Defaults to min(2, copiesNumber) if there are at least 2 OSDs, 1 otherwise.

401

Unauthorized request.

403

Forbidden request.

404

Ceph cluster not deployed.

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