Get Service Engine Group Assignment

Get Service Engine Group Assignment

Retrieves a specific Load Balancer Service Engine Group Assignment.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/loadBalancer/serviceEngineGroups/assignments/{assignmentId}
COPY
Path Parameters
string
assignmentId
Required

assignmentId

string
assignmentId
Required

assignmentId

Authentication
This operation uses the following authentication methods.
Responses
200
Returns LoadBalancerServiceEngineGroupAssignment of type(s) application/json;version=39.0 
{
    "id": "urn:vcloud:serviceEngineGroupAssignment:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "maxVirtualServices": 0,
    "minVirtualServices": 0,
    "numDeployedVirtualServices": 0,
    "serviceEngineGroupRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayOwnerRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayOrgRef": {
        "name": "string",
        "id": "string"
    },
    "serviceEngineGroupSupportedFeatureSet": "string",
    "gatewaySupportedFeatureSet": "string",
    "serviceEngineGroupHaMode": "string"
}
string
id
Optional

The identifier of the Load Balancer Service Engine Groups in URN format.

integer As int32 As int32
maxVirtualServices
Optional

The maximum number of virtual services the Edge Gateway is allowed to use. This is required if the Load Balancer Service Engine Group has reservation type 'SHARED'. This must be unset if the Load Balancer Service Engine Group has reservation type 'DEDICATED'.

integer As int32 As int32
minVirtualServices
Optional

The number of guaranteed virtual services available to the Edge Gateway. This is required if the Load Balancer Service Engine Group has reservation type 'SHARED'. This must be unset if the Load Balancer Service Engine Group has reservation type 'DEDICATED'.

integer
numDeployedVirtualServices
Optional

The current number of deployed virutal services.

EntityReference
serviceEngineGroupRef
Required

Entity reference used to describe VCD entities

EntityReference
gatewayRef
Required

Entity reference used to describe VCD entities

EntityReference
gatewayOwnerRef
Optional

Entity reference used to describe VCD entities

EntityReference
gatewayOrgRef
Optional

Entity reference used to describe VCD entities

string
serviceEngineGroupSupportedFeatureSet
Optional

The feature set supported by the Load Balancer Service Engine Group.

string
gatewaySupportedFeatureSet
Optional

The feature set supported by the Edge Gateway Load Balancer. This will be NULL if Load Balancer is not active on the associated Edge Gateway.

string
serviceEngineGroupHaMode
Optional

The service engine group's High Availability Mode.

  • ELASTIC_N_PLUS_M_BUFFER - Service Engines will scale out to N active nodes with M nodes as buffer.
  • ELASTIC_ACTIVE_ACTIVE - Active-Active with scale out.
  • LEGACY_ACTIVE_STANDBY - Traditional single Active-Standby configuration

Availability
Added in 35.0
On This Page
Load Balancer Service Engine Group Assignment Operations
DELETE
Delete Service Engine Group Assignment
GET
Get Service Engine Group Assignment
PUT
Update Service Engine Group Assignment