Get details of a remote Oneprovider
Returns the details of given provider. Only users belonging to that Oneprovider's cluster can fetch its details.
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Id of requested Oneprovider. |
Request Examples
onepanel-rest-cli getRemoteProvider id=VAiDGZbs3k0FD8jPhyU1 --host https://$PANEL_HOST:9443 -H "x-auth-token: $TOKEN"
Responses
The Oneprovider details.
The Oneprovider Id assigned by Onezone.
The name under which the Oneprovider has been registered in Onezone.
The fully qualified domain name of the Oneprovider.
The geographical longitude of the provider.
The geographical latitude of the provider.
The Id of the corresponding cluster record.
Indicates if the Oneprovider is currently online.
Example
{
"id": "VAiDGZbs3k0FD8jPhyU1",
"name": "Provider 1",
"domain": "provider.example.com",
"geoLongitude": -24.3776025,
"geoLatitude": -128.3519364,
"cluster": "kas90GcjRa9352ndfCxhGyYY9dx",
"online": true
}Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Forbidden request.
Request client is not member of given Oneprovider's cluster.
Internal server error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}