load-balancing-dns-traffic-property-load-feedback-summary

The following shows how to generate the load-balancing-dns-traffic-property-load-feedback-summary report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides DNS requests/sec and NXDomain response/sec.

Business object: fpdomain

Data available for: 90 days

Available metrics

MetricDescription
Data metrics
aliveTarget Alive = Up or Target Down = Down.
currentLoadCurrent of traffic actually sent for each Traffic Target.
hitsThe number of requests for the associated URL.
maxLoadThe Maximum traffic expected to be sent for each Traffic Target.
requestedLoadPercentage of traffic requested for each Traffic Target.Y
targetLoadTarget/requested traffic requested for each Traffic Target.
trafficTargetThe Traffic Target.

POST request

POST /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3/report-data{?start,​end}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp.
endString2020-06-01T00:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of fpdomain values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "alive",
        "currentLoad",
        "hits",
        "maxLoad",
        "requestedLoad",
        "targetLoad",
        "trafficTarget"
    ]
}

GET request

GET /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3/report-data{?start,​end,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=alive%2CcurrentLoad

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.
endString2020-06-01T00:00:00ZSpecifies if unavailable reports should be shown.
Optional
allObjectIdsBooleantrueAs an alternative to objectIds, enabling this generates a report that includes all IDs available for the fpdomain objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIdsString55232,​23433,​32433As an alternative to allObjectIds, specifies the set of unique IDs for the fpdomain objectType you want to report on, formatted as a comma-delimited list.
metricsStringalive,​currentLoadSpecifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "load-balancing-dns-traffic-property-load-feedback-summary",
        "version": "3",
        "outputType": "FLAT",
        "groupBy": [
            "trafficTarget"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "trafficTarget"
            },
            {
                "name": "alive",
                "label": "Alive"
            },
            {
                "name": "currentLoad",
                "label": "Current Load"
            },
            {
                "name": "hits",
                "label": "DNS Requests"
            },
            {
                "name": "maxLoad",
                "label": "Max Load"
            },
            {
                "name": "requestedLoad",
                "label": "Requested Load"
            },
            {
                "name": "targetLoad",
                "label": "Target Load"
            },
            {
                "name": "trafficTarget",
                "label": "Traffic Target"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "trafficTarget": 56273456,
            "alive": "Up",
            "currentLoad": "1640",
            "hits": "812",
            "maxLoad": "2611",
            "requestedLoad": 21,
            "targetLoad": "188"
        },
        {
            "trafficTarget": 54273611,
            "alive": "Down",
            "currentLoad": "2200",
            "hits": "1223",
            "maxLoad": "2540",
            "requestedLoad": 3.15,
            "targetLoad": "2802"
        },
        {
            "trafficTarget": "Other",
            "alive": "Other",
            "currentLoad": "32",
            "hits": "Other",
            "maxLoad": "538",
            "requestedLoad": "Other",
            "targetLoad": "3153"
        },
        {
            "trafficTarget": 922300,
            "alive": "Up",
            "currentLoad": "917",
            "hits": "900",
            "maxLoad": "2244",
            "requestedLoad": 82,
            "targetLoad": "3072"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-property-load-feedback-summary
version,​3
source,​load-balancing-dns-traffic-property-load-feedback-summary/versions/3
groupBy,​trafficTarget
start,​2020-05-01T00:00:00Z
end,​2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​fpdomain
objectIds,​55232,​23433,​32433
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
trafficTarget,​alive,​currentLoad,​hits,​maxLoad,​requestedLoad,​targetLoad,​trafficTarget
#COLUMNS_END

#DATA_START
56273456,Up,​1640,​812,​2611,​21,​188
54273611,Down,​2200,​1223,​2540,​3.15,​2802
Other,Other,​32,Other,​538,Other,​3153
922300,Up,​917,​900,​2244,​82,​3072
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the load-balancing-dns-traffic-property-load-feedback-summary report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-property-load-feedback-summary",
    "description": "Provides DNS requests/sec and NXDomain response/sec.",
    "businessObjectName": "fpdomain",
    "version": 3,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "available": true,
    "metrics": [
        {
            "name": "trafficTarget",
            "description": "The Traffic Target.",
            "label": "Traffic Target",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "alive",
            "description": "Target Alive = Up or Target Down = Down.",
            "label": "Alive",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "currentLoad",
            "description": "Current of traffic actually sent for each Traffic Target.",
            "label": "Current Load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "hits",
            "description": "The number of requests for the associated URL.",
            "label": "DNS Requests",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "maxLoad",
            "description": "The Maximum traffic expected to be sent for each Traffic Target.",
            "label": "Max Load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "requestedLoad",
            "description": "Percentage of traffic requested for each Traffic Target.Y",
            "label": "Requested Load",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "targetLoad",
            "description": "Target/requested traffic requested for each Traffic Target.",
            "label": "Target Load",
            "unit": "COUNT",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "trafficTarget"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback-summary/versions/3/report-data"
        }
    ]
}