Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get Ceph OSDs list.

GET /provider/ceph/osds

Return list of Ceph OSD configurations.

Request Examples

Shell

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

Responses

application/json

200

List of OSDs.

Property

Type & Description

osds

array of objects (CephOsd)

List of Ceph OSD specifications.

host required string Host on which given OSD should be deployed. It must be the full host name and not an "alias" as used in Oneprovider cluster deployment.
id required integer Id of the OSD.
uuid string UUID of the OSD daemon. If provided, will be used to skip deployment of existing OSDs (identified by the UUID). Must be a 32-character hex string. By default will be generated automatically.
type string Type of the OSD. Available types are: blockdevice - formats a raw block device to store the data loopdevice - stores data in a file mounted as loop device Enum: blockdevice
device string Specifies block device to be ERASED and FORMATTED for use as the main data store of this OSD.
type string Type of the OSD. Available types are: blockdevice - formats a raw block device to store the data loopdevice - stores data in a file mounted as loop device Enum: loopdevice
path string Path of the loopdevice file to be created. If omitted, default path will be generated according to following template: /volumes/persistence/ceph-loopdevices/osd-{uuid}.loop
size integer Size in bytes of the loopdevice file.

401

Unauthorized request.

403

Forbidden request.

404

Ceph is not deployed in the cluster.

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