Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get zone databases status

GET /zone/databases

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

Request Examples

Shell

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

Responses

application/json

200

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

No schema provided.

Example

application/json

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

401

Unauthorized request.

403

Forbidden request.

404

Database service has not been deployed.

500

Internal server error.

Property

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