Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Add zone databases

POST /zone/databases

Deploys a database service on provided hosts.

Request body

application/json

The service hosts configuration where databases should be deployed.

Property	Type & Description
hosts array of strings The list of hosts where service should be deployed.
serverQuota integer The server quota is the RAM memory in MiB that is allocated to the server when Couchbase Server is first installed. This sets the limit of RAM allocated by Couchbase for caching data for all buckets on each of the nodes. Optional, defaults to `4096` (4 GiB). NOTE: This parameter is taken into account only during the initial cluster deployment and ignored when adding new hosts to the cluster.
bucketQuota integer The bucket quota is the amount of RAM memory in MiB allocated to each individual bucket for caching data. Optional, defaults to `4096` (4 GiB). Optimally, should be set to the same value as `serverQuota`. NOTE: This parameter is taken into account only during the initial cluster deployment and ignored when adding new hosts to the cluster.

Request Examples

application/json

{
  "hosts": [
    "node1.example.com",
    "node2.example.com",
    "node3.example.com"
  ]
}

Responses

application/json

202

No description.

400

Invalid request.

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

401

Unauthorized request.

403

Forbidden request.

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