Get Virtual Service L4 Log Summaries

Get Virtual Service L4 Log Summaries

Retrieves L4 logs for a Virtual Service.

Log filters are encapsulated in a fiql filter query parameter. Sample filter: filter=(duration==900;endTime=2020-07-24T00:00:00) Supported filters are:

  • duration. Duration of the series. This is optional. If start time is not specified (or set to zero), this field determines the duration from end for which logs are returned. Default value is zero (no limit).
  • startTime. Start time of the logs. This is optional. Must be in ISO 8601 format (i.e. 2020-07-24T00:00:00.000Z). Defaults to zero.
  • endTime. End time of the logs. This is optional. Must be in ISO 8601 format (i.e. 2020-07-24T00:00:00.000Z). Defaults to the current time.
  • type. Type of logs to display in a comma-separated list. Can be CRITICAL or NON_CRITICAL. This is optional. Default value is CRITICAL.
  • clientIpAddress. IP address of the client. This is optional. Must be in IPv4 format. This field is responsible for filtering logs based on the specified client IP.
  • ipV6ClientIpAddress. IPv6 address of the client. This is optional. Must be in IPv6 format. This field is responsible for filtering logs based on the specified client IP.
  • applicationPort. Application port on which load balancer connection has been made. This is optional. This field is responsible for filtering logs based on the specified application port.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/loadBalancer/virtualServices/{virtualServiceId}/l4Logs
COPY
Path Parameters
string
virtualServiceId
Required

virtualServiceId

string
virtualServiceId
Required

virtualServiceId

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.


Authentication
This operation uses the following authentication methods.
Responses
200
Returns EdgeVirtualServiceL4LogSummaries of type(s) application/json;version=38.1
This response body class contains all of the following: Page , InlineEdgeVirtualServiceL4LogSummaries1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "criticalityCodes": [
                "string"
            ],
            "criticalitySummary": "string",
            "timestamp": "2020-07-24T00:00:00.000+0000",
            "protocol": "string",
            "type": "string",
            "totalTime": 0,
            "clientIpAddress": "string",
            "ipV6ClientIpAddress": "string",
            "clientPort": 0,
            "clientLocation": "string",
            "clientRtt": 0,
            "startTimestamp": "2020-07-24T00:00:00.000+0000",
            "totalBytes": 0,
            "rxBytes": 0,
            "txBytes": 0,
            "totalPackets": 0,
            "rxPackets": 0,
            "txPackets": 0,
            "outOfOrders": 0,
            "timeouts": 0,
            "retransmits": 0,
            "windowShrinkCount": 0,
            "zeroWindowSizeEvents": 0,
            "transactionCount": 0,
            "averageTurntime": 0,
            "maxSegmentSize": 0,
            "synRetransmitCount": 0,
            "applicationIpAddress": "string",
            "ipV6ApplicationIpAddress": "string",
            "applicationPort": 0,
            "applicationRtt": 0,
            "applicationTotalBytes": 0,
            "applicationRxBytes": 0,
            "applicationTxBytes": 0,
            "applicationTotalPackets": 0,
            "applicationRxPackets": 0,
            "applicationTxPackets": 0,
            "applicationOutOfOrders": 0,
            "applicationTimeouts": 0,
            "applicationRetransmits": 0,
            "applicationZeroWindowSizeEvents": 0,
            "persistenceUsed": false,
            "applicationWindowShrinkCount": 0,
            "sslVersion": "string",
            "sslCipher": "string"
        }
    ]
}