Get Load Balancer Analytic Reports

Retrieves analytics for a specific load balancer. Metrics are specified in the filter query along with time period and series resolution. Up to 5 metric series can be specified per report. All reports will span the same time period.

Report filters are encapsulated in a fiql filter query parameter. Sample filter: filter=(componentId==urn:vcloud:virtualservice:7d38ad7f-cd93-4501-8c40-6f61650ccda0; metric==l4_server.avg_total_rtt;metric==l7_server.avg_application_response_time;step==500;limit==100) Supported filters are:

componentId. The URN of the virtual service or pool for which metrics will be gathered. Only one should be specified. This is required.
metric. One or more metrics of interest. filter=(metric==l4_server.avg_total_rtt;metric==l7_server.avg_application_response_time) - This is required. Supported metrics can be found at the analytics/supportedMetrics endpoint.
step. The time resolution of the report, in seconds. This is required. Minimum supported resolution is 300 seconds (5 minutes).
limit. Optional. The number of data points to be returned. This is optional. Defaults to 59 where it can't be calculated.
startTime. Start time of the series. This is optional. Must be in ISO 8601 format (i.e. 2020-07-24T00:00:00). If not provided, start time is calculated from the step and end time.
endTime. End period of the series. This is optional. Must be in ISO 8601 format (i.e. 2020-07-24T00:00:00). Defaults to the time of latest collected data point.

This requires an Edge Gateway Load Balancer with PREMIUM feature set.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/loadBalancer/analyticReports

COPY

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns EdgeLoadBalancerAnalyticReports of type(s) application/json;version=37.0

{
    "values": [
        {
            "gatewayId": "string",
            "componentId": "string",
            "metric": "string",
            "units": "string",
            "statistics": {
                "mean": "number",
                "min": "number",
                "max": "number",
                "trend": "number",
                "sampleSize": "number",
                "startTime": "string",
                "endTime": "string"
            },
            "data": [
                {
                    "timestamp": "string",
                    "value": "string"
                }
            ]
        }
    ]
}

array of EdgeLoadBalancerAnalyticReport

values

Optional

values

Availability

Added in 35.0

On This Page

Description

Request

Query Parameters

Authentication

Response