Get current provider's domain config
Returns the domain config of the Oneprovider that performed the request.
This operation requires provider authentication - see provider auth token.
Example cURL requests
Get provider's domain config
curl -sS -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/provider/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
}
Request Examples
onezone-rest-cli getCurrentProviderDomainConfigResponses
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 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
{
"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
}Invalid request.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}