List effective harvester groups
Returns the effective list of groups belonging to a specific harvester.
This operation requires harvester_view privilege
or oz_harvesters_list_relationships admin privilege.
Example cURL requests
Get harvester effective groups
curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/harvesters/$HARVESTER_ID/effective_groups
{
"groups": [
"f1c8b1a37aa7447b22eb65a742d40524",
"8e1cea0b379e3683257c32f896d55115"
]
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Harvester Id. |
Request Examples
onezone-rest-cli listEffectiveHarvesterGroups id=b752ceafabb662b4e5728b2ded25cdd1Responses
The list of effective group Ids that belong to a specific harvester.
The list of group Ids.
Example
{
"groups": [
"1d24c36707d99197c6cd995810a43aca",
"6825604b0eb6a47b8b7a04b6369eb24d"
]
}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."
}
}Authentication 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."
}
}Authorization 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."
}
}Resource not found.
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."
}
}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."
}
}