Get Pool Summaries For Gateway

Get Pool Summaries For Gateway

Retrieves summaries for all of the Load Balancer Pools that are configured for an Edge Gateway.

Use healthMonitorId filter to retrieve Load Balancer Pools which are associated with the specified Health Monitor. filter=(healthMonitorId==urn:vcloud:loadBalancerHealthMonitor:cfa7d4bf-73d7-4214-adc3-e45ff42121e4)

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer/poolSummaries
COPY
Path Parameters
string
gatewayId
Required

gatewayId

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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeLoadBalancerPoolSummaries of type(s) application/json;version=39.1
This response body class contains all of the following: InlineEdgeLoadBalancerPoolSummaries0 , InlineEdgeLoadBalancerPoolSummaries1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": {},
            "id": "string",
            "description": "string",
            "enabled": false,
            "passiveMonitoringEnabled": false,
            "healthStatus": "string",
            "memberCount": 0,
            "enabledMemberCount": 0,
            "upMemberCount": 0,
            "healthMessage": "string",
            "name": "string",
            "activeMonitoringEnabled": false,
            "virtualServiceRefs": [
                {
                    "name": "string",
                    "id": "string"
                }
            ],
            "memberSslEnabled": false,
            "memberGroupType": "string"
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer/poolSummaries?page=value&pageSize=v
Availability
Added in 35.0
On This Page
Edge Gateway Load Balancer Pools Operations
GET
Get Pool Summaries For Gateway
POST
Create Load Balancer Pool