Get Virtual Service Summaries For Gateway

Get Virtual Service Summaries For Gateway

Retrieves all Virtual Service Summaries for an Edge Gateway.

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

gatewayId

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

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeLoadBalancerVirtualServiceSummaries of type(s) application/json;version=38.0
This response body class contains all of the following: Page , InlineEdgeLoadBalancerVirtualServiceSummaries1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "enabled": false,
            "virtualIpAddress": "string",
            "ipv6VirtualIpAddress": "string",
            "loadBalancerPoolRef": {
                "name": "string",
                "id": "string"
            },
            "gatewayRef": {
                "name": "string",
                "id": "string"
            },
            "serviceEngineGroupRef": {
                "name": "string",
                "id": "string"
            },
            "certificateRef": {
                "name": "string",
                "id": "string"
            },
            "servicePorts": [
                {
                    "tcpUdpProfile": {
                        "name": "string",
                        "type": "string",
                        "systemDefined": false
                    },
                    "portStart": 0,
                    "portEnd": 0,
                    "sslEnabled": false
                }
            ],
            "healthStatus": "string",
            "healthMessage": "string",
            "detailedHealthMessage": "string",
            "transparentModeEnabled": false,
            "nonCriticalLoggingEnabled": false,
            "applicationProfileType": "string"
        }
    ]
}

Availability
Added in 35.0
On This Page
Edge Gateway Load Balancer Virtual Services Operations
POST
Create Virtual Service
GET
Get Virtual Service Summaries For Gateway