Get Health Monitor Summaries For Gateway

Retrieves summaries for all of the Load Balancer Pool Health Monitors that are available for association with Load Balancer Pools belonging to an Edge Gateway. Health Monitor filters are encapsulated in a fiql filter query parameter. Sample filter: filter=(loadBalancerPoolId==urn:vcloud:loadBalancerPool:7d38ad7f-cd93-4501-8c40-6f61650ccda0) Supported filters are:

loadBalancerPoolId. The URN of the pool with which the health monitors are associated. Only one should be specified. If not specified, all health monitors associated with this gateway are returned.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer/healthMonitorSummaries

COPY

Path Parameters

string

gatewayId

Required

gatewayId

string

gatewayId

Required

gatewayId

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

integer

page

Required

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns EdgeLoadBalancerHealthMonitorSummaries of type(s) application/json;version=39.0

This response body class contains all of the following: Page , InlineEdgeLoadBalancerHealthMonitorSummaries1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "poolCount": 0,
            "scope": "string"
        }
    ]
}

Availability

Added in 39.0

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Edge Gateway Load Balancer Health Monitors Operations

POST