Get Service Engine Groups
Retrieves all Load Balancer Service Engine Groups. Supported filters are:
- Gateway ID
(gatewayId==[ID])
- | Returns all Load Balancer Service Engine Groups that are accessible to the gateway. - Assignable Gateway ID
(gatewayId==[ID];assignable==true)
- | Returns all Load Balancer Service Engine Groups that are assignable to the gateway. This filters out any Load Balancer Service Engine groups that are already assigned to the gateway or assigned to another gateway if the reservation type is 'DEDICATED'. If the gateway supports 'PREMIUM' features for load balancing, this will also filter out the Service Engine groups which has 'STANDARD' max supported feature set.
(_context==gatewayId)
, Assignable Gateway ID (_context==gatewayId;_context==assignable)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/loadBalancer/serviceEngineGroups
COPY
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns LoadBalancerServiceEngineGroups of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineLoadBalancerServiceEngineGroups1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"status": {},
"id": "urn:vcloud:serviceEngineGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "string",
"description": "string",
"serviceEngineGroupBacking": {
"backingId": "serviceenginegroup-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"backingName": "string",
"loadBalancerCloudRef": {
"name": "string",
"id": "string"
}
},
"haMode": "string",
"reservationType": "string",
"maxVirtualServices": 0,
"numDeployedVirtualServices": 0,
"reservedVirtualServices": 0,
"overAllocated": false,
"supportedFeatureSet": "string"
}
]
}
Availability
Added in 35.0
Load Balancer Service Engine Groups Operations
POST
Create Service Engine Group
GET
Get Service Engine Groups