Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Get Ceph OSD

GET /provider/ceph/osds/{id}

Returns details of a Ceph OSD instance.

Path parameters

Parameter Type & Description
id required
string

Id of the Ceph OSD to describe.

Request Examples

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

Responses

application/json
200

Ceph OSD specification.

PropertyType & Description
host
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
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.

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