DNS Application Service Summary

Overview

A summary overview for an DNS application service, managed by the BIG-IP devices that are connected to BIG-IQ centralized management.

REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/DnsApplicationServiceSummary

Requests

GET /mgmt/ap/query/v1/tenants/default/reports/DnsApplicationServiceSummary

Query Parameters

Name Type Required Description
$appService string True Specifies the application service name.
$from string False Specifies time to start results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time.
$to string False Specifies time to end results. The default uses the values of “-5m” for from and “now” for to, which starts from 5 minutes before the current time and ends at the current time.
$securityFrom string False Specifies the earliest application service security data shown over the elapsed time period. The default uses the values of “-1d” for securityFrom and “now” for to, which starts from 1 day before the current time and ends at the current time.
$from-TS string False Specify time to start results for sparklines. The default uses the values of “-1h” for from-TS and “now” for to, which starts from 1 hour before the current time and ends at the current time.
$resolution-minutes-TS string False Data values shown according to time increments in minutes. The default value is 5 minutes.

Response

HTTP/1.1 200 OK

Name Type Description
health HealthEnum The application service’s health. Possible values “Critical”, “Moderate”, “Good” or “Other”.
totalRps number The current Total requests per second statistics.
totalRpsTs object The application service’s Total requests per second statistics over time.
     timeMillis number The end time of the specific time slot within the time period.
     count number The number of data samples collected in the specific time slot.
     totalRps number The Total requests per second for the specific time slot.
preferredRps number The current Preferred requests per second statistics.
preferredRpsTs object The application service’s Preferred requests per second statistics over time.
     timeMillis number The end time of the specific time slot within the time period.
     count number The number of data samples collected in the specific time slot.
     preferredRps number The Preferred requests per second for the specific time slot.
alternateRps number The current Alternate requests per second statistics.
alternateRpsTs object The application service’s Alternate requests per second statistics over time.
     timeMillis number The end time of the specific time slot within the time period.
     count number The number of data samples collected in the specific time slot.
     alternateRps number The Alternate requests per second for the specific time slot.
fallbackRps number The current Fallback requests per second statistics.
fallbackRpsTs object The application service’s Fallback requests per second statistics over time.
     timeMillis number The end time of the specific time slot within the time period.
     count number The number of data samples collected in the specific time slot.
     fallbackRps number The Fallback requests per second for the specific time slot.
unresolvedRps number The current Unresolve requests per second statistics.
unresolvedRpsTs object The application service’s Unresolve requests per second statistics over time.
     timeMillis number The end time of the specific time slot within the time period.
     count number The number of data samples collected in the specific time slot.
     unresolvedRps number The Unresolve requests per second for the specific time slot.
trafficDistribution object The application service’s current load-balancing distribution.
     unresolved number The percentage of Unresolved requests.
     alternate number The percentage of Alternate requests.
     fallback number The percentage of Rallback requests.
     preferred number The percentage of Preferred requests.
alertsHistory object Summary of the application service’s active alerts history.
     id string The alert’s unique identifier.
     title string A short description of the alert.
     startTime number The time in which the alert was raised.
     timestamp number The time in which the alert was updated.
     severity string The severity of the alert.
     severityLevel number The severity’s numeric value.
activeAlerts object Summary of the application service’s active alerts.
     id string The alert’s unique identifier.
     title string A short description of the alert.
     severity string The severity of the alert.
     severityLevel number The severity’s numeric value.

Permissions

Role Allow
Application Viewer Yes
Application Manager Yes
Application Creator Yes
Application Editor Yes

Examples

GET to retrieve summary of a single specified application

Following is an example of a response to the default API call, with only the required $appService parameter.

GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/DnsApplicationServiceSummary?$appService=boston_dns

Response

{
 "kind": "ap:compose:Report",
 "lastUpdateMicros": 117510902191,
 "result": {
     "totalRpsTs": [
         {
             "timeMillis": 1568128500000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568128800000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568129100000,
             "count": 0,
             "totalRps": 0.2
         },
         {
             "timeMillis": 1568129400000,
             "count": 0,
             "totalRps": 0.31666666666666665
         },
         {
             "timeMillis": 1568129700000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568130000000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568130300000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568130600000,
             "count": 0,
             "totalRps": 0.39666666666666667
         },
         {
             "timeMillis": 1568130900000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568131200000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568131500000,
             "count": 0,
             "totalRps": 0.4
         },
         {
             "timeMillis": 1568131650000,
             "count": 0,
             "totalRps": 0.4
         }
     ],
     "preferredRpsTs": [
         {
             "timeMillis": 1568128500000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568128800000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568129100000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568129400000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568129700000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568130000000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568130300000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568130600000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568130900000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568131200000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568131500000,
             "count": 0,
             "preferredRps": 0.0
         },
         {
             "timeMillis": 1568131650000,
             "count": 0,
             "preferredRps": 0.0
         }
     ],
     "alternateRpsTs": [
         {
             "timeMillis": 1568128500000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568128800000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568129100000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568129400000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568129700000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568130000000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568130300000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568130600000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568130900000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568131200000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568131500000,
             "count": 0,
             "alternateRps": 0.0
         },
         {
             "timeMillis": 1568131650000,
             "count": 0,
             "alternateRps": 0.0
         }
     ],
     "fallbackRpsTs": [
         {
             "timeMillis": 1568128500000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568128800000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568129100000,
             "count": 0,
             "fallbackRps": 0.2
         },
         {
             "timeMillis": 1568129400000,
             "count": 0,
             "fallbackRps": 0.31666666666666665
         },
         {
             "timeMillis": 1568129700000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568130000000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568130300000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568130600000,
             "count": 0,
             "fallbackRps": 0.39666666666666667
         },
         {
             "timeMillis": 1568130900000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568131200000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568131500000,
             "count": 0,
             "fallbackRps": 0.4
         },
         {
             "timeMillis": 1568131650000,
             "count": 0,
             "fallbackRps": 0.4
         }
     ],
     "unresolvedRpsTs": [
         {
             "timeMillis": 1568128500000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568128800000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568129100000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568129400000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568129700000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568130000000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568130300000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568130600000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568130900000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568131200000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568131500000,
             "count": 0,
             "unresolvedRps": 0.0
         },
         {
             "timeMillis": 1568131650000,
             "count": 0,
             "unresolvedRps": 0.0
         }
     ],
     "alertsHistory": [
         {
             "id":"áÌط߁¢",
             "publish": "true",
             "title": "Application Service Health: Critical (defaultPartition_testAS3App2_1568023894003)",
             "startTime": 1568131807081,
             "timestamp": 1568131807081,
             "severity": "Critical",
             "severityLevel": 2,
             "timeWindow": {
                 "timeInterval": 0,
                 "end": 1568131807081
             }
         },
         {
             "id": "Bîì‚ýK=Ä",
             "publish": "true",
             "title": "Increased Ratio of Dropped DNS RPS exceeded 50%",
             "startTime": 1568131806992,
             "timestamp": 1568131806992,
             "severity": "Critical",
             "severityLevel": 2,
             "timeWindow": {
                 "timeInterval": 0,
                 "end": 1568131806992
             }
         },
         {
             "id": "JXšç’{ó?",
             "publish": "true",
             "title": "Increased Ratio of Fallback DNS Load Balancing exceeded 50%",
             "startTime": 1568131803445,
             "timestamp": 1568131803445,
             "severity": "Critical",
             "severityLevel": 2,
             "timeWindow": {
                 "timeInterval": 0,
                 "end": 1568131803445
             }
         },
         {
             "id":"±ƒ¯N&;5",
             "publish": "true",
             "title": "Application Service Health: Critical (defaultPartition_testAS3App2_1568023894003)",
             "startTime": 1568129522119,
             "timestamp": 1568131562814,
             "severity": "Critical",
             "severityLevel": 2,
             "timeWindow": {
                 "timeInterval": 0,
                 "end": 1568131562814
             }
         },
         {
             "id":"\u000b",
             "publish": "true",
             "title": "Inactive Alert: Increased Ratio of Dropped DNS RPS exceeded 50%",
             "startTime": 1568129522082,
             "timestamp": 1568131562790,
             "severity": "Cleared",
             "severityLevel": 0,
             "timeWindow": {
                 "timeInterval": 0,
                 "end": 1568131562790
             }
         }
     ],
     "activeAlerts": [
         {
             "id": "Bîì‚ýK=Ä",
             "publish": "true",
             "title": "Increased Ratio of Dropped DNS RPS exceeded 50%",
             "severity": "Critical",
             "severityLevel": 2
         },
         {
             "id":"áÌط߁¢",
             "publish": "true",
             "title": "Application Service Health: Critical (defaultPartition_testAS3App2_1568023894003)",
             "severity": "Critical",
             "severityLevel": 2
         },
         {
             "id": "JXšç’{ó?",
             "publish": "true",
             "title": "Increased Ratio of Fallback DNS Load Balancing exceeded 50%",
             "severity": "Critical",
             "severityLevel": 2
         }
     ],
     "trafficDistribution": {
         "unresolved": 0.0,
         "alternate": 0.0,
         "fallback": 100.0,
         "preferred": 0.0
     },
     "totalRps": 0.4,
     "preferredRps": 0.0,
     "alternateRps": 0.0,
     "fallbackRps": 0.4,
     "unresolvedRps": 0.0,
     "health": "Critical"
 },
 "requestDurationInMillis": 1039
 }