Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get OneS3 service status on a host

GET /provider/ones3/{host}

Returns the status of the OneS3 service on the selected host.

Path parameters

Parameter Type & Description
host required
string

The cluster host for which the OneS3 service status should be returned.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getOnes3StatusOnHost host=s3.example.com --host https://$OP_PANEL_HOST:9443

Responses

application/json
200

The status of the OneS3 service on the selected host.

No schema provided.

401

Unauthorized request.

403

Forbidden request.

404

OneS3 service has not been deployed on the selected host.

500

Internal server error.

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