Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Start/stop OneS3 service on a host

PATCH /provider/ones3/{host}

Starts or stops the OneS3 service on the selected host in the cluster.

NOTE: the OneS3 service requires that the provider is registered in Onezone before it can be started. If it's not the case, the start of the service will be postponed and automatically resumed after the registration.

Path parameters

Parameter	Type & Description
host required	string The cluster host for which OneS3 service status should be changed.

Query parameters

Parameter	Type & Description
started	boolean Defines the intended state of the OneS3 service. The service will be started or stopped in order to match the requested state. Starting may be postponed (see the description).

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE startStopOnes3OnHost started=false --host https://$OP_PANEL_HOST:9443

Responses

application/json

204

OneS3 service state changed successfully.

401

Unauthorized request.

403

Forbidden request.

404

OneS3 service has not been deployed on the selected host.

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