Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get OneS3 service status (cluster-wide)

GET /provider/ones3

Returns the status of OneS3 service on each host where it has been deployed.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getOnes3StatusClusterWide --host https://$OP_PANEL_HOST:9443

Responses

application/json

200

The status of OneS3 service on each host where it has been deployed.

Property

Type & Description

<key>

string

The service status.

Enum:

starting healthy unhealthy stopping stopped missing

Example

application/json

{
  "node1.oneprovider.onedata.example.com": "healthy",
  "node2.oneprovider.onedata.example.com": "stopped"
}

401

Unauthorized request.

403

Forbidden request.

404

OneS3 service has not been deployed.

500

Internal server error.

Property

Type & Description

error

object (ErrorDetails)

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