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://$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"]
}
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 or its IP address (only for single-node deployments or clusters with a reverse proxy). | |
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 IP addresses advertised by Onezone on behalf of the Oneprovider. Applicable if subdomain delegation is enabled, empty list otherwise. | |
Example
{
"subdomainDelegation": true,
"domain": "provider1.onezone.example.com",
"subdomain": "provider1",
"ipList": [
"172.17.0.1",
"172.17.0.2",
"172.17.0.3"
]
}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."
}
}