HTTP Application Service Summary¶
Overview¶
A summary overview for an HTTP 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/ApplicationSummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/ApplicationSummary¶
Query Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| $app | 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”. |
| protectionMode | string | The application service’s protection mode. Possible values: “notProtected”, “transparent” or “blocking”. |
| badTraffic | double | The application service’s bad traffic rate |
| badTrafficGrowth | Boolean | Does the application service’s bad traffic grow over time? |
| findings | string | The application service’s security findings. “blockingValidTraffic” means traffic that was blocked due to false positives by blocking protection status. “successfulAttack” means traffic that was allowed, even though identified as an attack, due to transparent protection status. “blockedAttacks” means an identified attack value increased significantly over the past day, in relation to the past week. “dosSuccessfulAttack” means traffic that was allowed, even though identified as an DoS attack, due to transparent protection status. “dosBlockedAttacks” means traffic that was blocked due to false positives by blocking protection status. “none” - No attacks to the application were detected. |
| 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. |
| appsStats | object | The application service’s metrics. |
| appResponseTime | number | The application service response time. |
| transactionsPerSecond | number | The application service’s HTTP transactions per second. |
| appsStatsTs | object | The application service’s metrics 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. |
| appResponseTime | number | The avarage response time for the specific time slot. |
| transactionsPerSecond | number | HTTP transaction per second for the specific time slot. |
| connections | number | The number of open connections. |
| connectionsTs | object | The number of open connections 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. |
| connections | number | The number of open connections for the specific time slot. |
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 $app parameter.
GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/ApplicationSummary?$app=seattle_MyWebApp218
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 206838367088,
"result": {
"protectionMode": "Not Protected",
"badTraffic": 0.0,
"badTrafficGrowth": false,
"alertsHistory": [
{
"id": "GUID value",
"publish": "true",
"title": "Application Service Health: Moderate (seattle_MyWebApp218)",
"startTime": 1563758525844,
"timestamp": 1563758525844,
"severity": "Warning",
"severityLevel": 1,
"timeWindow": {
"timeInterval": 0,
"end": 1563758525844
}
},
{
"id": "GUID value",
"publish": "true",
"title": "/seattle/MyWebApp218/serviceMain: Health status is moderate",
"startTime": 1563758525423,
"timestamp": 1563758525423,
"severity": "Warning",
"severityLevel": 1,
"timeWindow": {
"timeInterval": 0,
"end": 1563758525423
}
},
{
"id": "GUID value",
"publish": "true",
"title": "Application Service Health: Moderate (seattle_MyWebApp218)",
"startTime": 1563753963889,
"timestamp": 1563753963889,
"severity": "Warning",
"severityLevel": 1,
"timeWindow": {
"timeInterval": 0,
"end": 1563753963889
}
},
{
"id": "GUID value",
"publish": "true",
"title": "/seattle/MyWebApp218/serviceMain: Health status is moderate",
"startTime": 1563753963588,
"timestamp": 1563753963588,
"severity": "Warning",
"severityLevel": 1,
"timeWindow": {
"timeInterval": 0,
"end": 1563753963588
}
},
{
"id": "GUID value",
"publish": "true",
"title": "Application Service Health: Good (seattle_MyWebApp218)",
"startTime": 1563752161091,
"timestamp": 1563753900222,
"severity": "Cleared",
"severityLevel": 0,
"timeWindow": {
"timeInterval": 0,
"end": 1563753900222
}
}
],
"findings": "None",
"health": [
"Moderate"
],
"appsStatsTs": [
{
"appResponseTime": 0.39473684210526316,
"timeMillis": 1563783000000,
"transactionsPerSecond": 0.12666666666666668
},
{
"appResponseTime": 0.17567567567567569,
"timeMillis": 1563783300000,
"transactionsPerSecond": 0.24666666666666667
},
{
"appResponseTime": 0.23684210526315788,
"timeMillis": 1563783600000,
"transactionsPerSecond": 0.12666666666666668
},
{
"appResponseTime": 0.55,
"timeMillis": 1563783900000,
"transactionsPerSecond": 0.06666666666666667
},
{
"appResponseTime": 0.26785714285714285,
"timeMillis": 1563784200000,
"transactionsPerSecond": 0.18666666666666668
},
{
"appResponseTime": 0.2894736842105263,
"timeMillis": 1563784500000,
"transactionsPerSecond": 0.12666666666666668
},
{
"appResponseTime": 0.1891891891891892,
"timeMillis": 1563784800000,
"transactionsPerSecond": 0.24666666666666667
},
{
"appResponseTime": 0.23214285714285715,
"timeMillis": 1563785100000,
"transactionsPerSecond": 0.18666666666666668
},
{
"appResponseTime": 0.75,
"timeMillis": 1563785400000,
"transactionsPerSecond": 0.06666666666666667
},
{
"appResponseTime": 0.21621621621621623,
"timeMillis": 1563785700000,
"transactionsPerSecond": 0.24666666666666667
},
{
"appResponseTime": 0.3684210526315789,
"timeMillis": 1563786000000,
"transactionsPerSecond": 0.12666666666666668
},
{
"appResponseTime": 0.22641509433962265,
"timeMillis": 1563786270000,
"transactionsPerSecond": 0.1962962962962963
}
],
"activeAlerts": {
"alerts": [
{
"id": "GUID value",
"publish": "true",
"title": "/seattle/MyWebApp218/serviceMain: Health status is moderate",
"severity": "Warning",
"severityLevel": 1
},
{
"id": "GUID value",
"publish": "true",
"title": "Application Service Health: Moderate (seattle_MyWebApp218)",
"severity": "Warning",
"severityLevel": 1
}
]
},
"connectionsTs": [
{
"timeMillis": 1563783000000,
"connections": 0.0
},
{
"timeMillis": 1563783300000,
"connections": 0.0
},
{
"timeMillis": 1563783600000,
"connections": 0.0
},
{
"timeMillis": 1563783900000,
"connections": 0.0
},
{
"timeMillis": 1563784200000,
"connections": 0.0
},
{
"timeMillis": 1563784500000,
"connections": 0.0
},
{
"timeMillis": 1563784800000,
"connections": 0.0
},
{
"timeMillis": 1563785100000,
"connections": 0.0
},
{
"timeMillis": 1563785400000,
"connections": 0.0
},
{
"timeMillis": 1563785700000,
"connections": 0.0
},
{
"timeMillis": 1563786000000,
"connections": 0.0
},
{
"timeMillis": 1563786270000,
"connections": 0.0
}
],
"appsStats": [
{
"appResponseTime": 0.22641509433962265,
"transactionsPerSecond": 0.1962962962962963
}
],
"connections": 0.0
},
"requestDurationInMillis": 463
}