Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get provider's domain config

GET /providers/{id}/domain_config

Returns the domain config of specific provider.

This operation requires any of the following authentication:

as the subject provider ({id}),
as user who has cluster_view privilege in the cluster corresponding to the subject provider,
as user who has oz_providers_view admin privilege.

Example cURL requests

Get provider's domain config

curl -sS -u username:password -X GET  \
https://$ZONE_HOST/api/v3/onezone/providers/$PROVIDER_ID/domain_config

{
  "subdomainDelegation": true,
  "domain": "provider1.onezone.example.com",
  "subdomain": "provider1",
  "ipList": ["172.17.0.1", "172.17.0.2", "172.17.0.3"],
  "opWorkerIpAddresses": ["172.17.0.1", "172.17.0.2", "172.17.0.3"],
  "opWorkerPort": 443,
  "oneS3IpAddresses": ["172.17.0.1", "172.17.0.2", "172.17.0.3"],
  "oneS3Port": 4443
}

Path parameters

Parameter	Type & Description
id required	string Provider Id.

Request Examples

Shell

onezone-rest-cli getProviderDomainConfig id=0f7fa3347bd2f090acc6ed246e1f1747

Responses

application/json

200

The provider's domain config.

Property	Type & Description
subdomainDelegation boolean True if this Oneprovider has been assigned a subdomain in Onezone's domain.
domain string The fully qualified domain name of the Oneprovider. In rare cases, the domain may have the form of an IP address instead of an FQDN.
subdomain string Unique subdomain in Onezone's domain for the Oneprovider. Applicable if subdomain delegation is enabled, null otherwise.
ipList array of strings The list of Oneprovider Worker IP addresses advertised by Onezone on behalf of the Oneprovider. Applicable if subdomain delegation is enabled, empty list otherwise. Deprecated in favor of `opWorkerIpAddresses`.
opWorkerIpAddresses array of strings The list of Oneprovider Worker IP addresses advertised by Onezone on behalf of the Oneprovider. Applicable if subdomain delegation is enabled, empty list otherwise.
opWorkerPort integer The port number of Oneprovider Worker advertised by Onezone on behalf of the Oneprovider.
oneS3IpAddresses array of strings The list of Oneprovider OneS3 IP addresses advertised by Onezone on behalf of the Oneprovider. Applicable if subdomain delegation is enabled, empty list otherwise.
oneS3Port integer The port number of Oneprovider OneS3 advertised by Onezone on behalf of the Oneprovider.

Example

application/json

{
  "subdomainDelegation": true,
  "domain": "provider1.onezone.example.com",
  "subdomain": "provider1",
  "ipList": [
    "172.17.0.1",
    "172.17.0.2",
    "172.17.0.3"
  ],
  "opWorkerIpAddresses": [
    "172.17.0.1",
    "172.17.0.2",
    "172.17.0.3"
  ],
  "opWorkerPort": 443,
  "oneS3IpAddresses": [
    "172.17.0.1",
    "172.17.0.2",
    "172.17.0.3"
  ],
  "oneS3Port": 9999
}

400

Invalid request.

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

401

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

403

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

404

Resource not found.

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

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