Get Load Balancer Health Monitor Assignments

Get Load Balancer Health Monitor Assignments

Retrieves all Load Balancer Pool Health Monitors assignments. Health Monitor filters are encapsulated in a fiql filter query parameter. One of the filters, "healthMonitorRef.id" or "loadBalancerPoolRef.id" is required. Sample filter: filter=(healthMonitorRef.id==urn:vcloud:loadBalancerHealthMonitor:cfa7d4bf-73d7-4214-adc3-e45ff42121e4) filter=(loadBalancerPoolRef.id==urn:vcloud:loadBalancerPool:7d38ad7f-cd93-4501-8c40-6f61650ccda0) Supported filters are:

  • healthMonitorRef.id. The URN of the health monitor which is assigned to pools. Only one should be specified. If not specified, all health monitors assigned to pools are returned.
  • loadBalancerPoolRef.id. The URN of the pool with which the health monitors are associated. Only one should be specified.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/loadBalancer/healthMonitors/assignments
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

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 EdgeLoadBalancerHealthMonitorAssignments of type(s) application/json;version=39.1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "healthMonitorRef": {
                "name": "string",
                "id": "string"
            },
            "loadBalancerPoolRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/loadBalancer/healthMonitors/assignments?page=value&pageSize=v
Availability
Added in 39.0
On This Page
Edge Gateway Load Balancer Health Monitor Assignments Operations
GET
Get Load Balancer Health Monitor Assignments
POST
Create Load Balancer Health Monitor Assignment
GET
Get Load Balancer Health Monitor Assignment
DELETE
Delete Load Balancer Health Monitor Assignment