Application Services Summary¶
Overview¶
A summary overview of all application services grouped under a specified application, managed by the BIG-IP devices that are connected to BIG-IQ centralized management.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/ApplicationServicesSummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/ApplicationServicesSummary¶
Query Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| $appId | string | True | Specifies the id of the application for an application services group. |
| $limit | string | False | Specify the max number of top results to be returned. The default value is “5”. |
| $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. |
| $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 | object | The number of application services by health status of Critical, Moderate, Good, or Other. |
| critical | number | The number of objects with a critical health status |
| good | number | The number of objects with a good health status |
| moderate | number | The number of objects with a moderate health status |
| other | number | The number of objects with an unknown health status |
| response-time | object | Top application services by average response time. |
| application | string | The application service’s readable name |
| response-time | number | The average application service’s response time. |
| http-tps | object | Top application services by average HTTP transactions per second. |
| application | string | The application service’s readable name |
| http-tps | number | The application service’s average HTTP transactions per second. |
| concurrent-connections | object | Top application services by average number of open connections. |
| application | string | The application service’s readable name |
| concurrent-connections | number | The application service’s average number of open connections. |
| numOfAppsNotProtected | number | Number of application services without protection. |
| numOfAppsWithBadTrafficGrowth | number | Number of application services that display bad traffic growth. |
| numOfAppsWithBlockingValidTraffic | number | Number of application services that display false positives attacks. |
| numOfAppsWithSuccessfulAttacks | number | Number of application services that display potentially harmful attacks. |
| totalApplications | number | Total number of application services contained in the specified application. |
| dnsTotalRps | number | Total DNS requests per second. |
| dnsTotalRpsTs | object | Total DNS requests per second 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. |
| dnsTotalRps | number | DNS requests per second for the specific time slot. |
| dnsUnhandledRps | number | Unhandled DNS requests per second. |
| dnsUnhandledRpsTs | object | Unhandled DNS requests per second 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. |
| dnsUnhandledRps | number | Unhandled DNS requests per second for the specific time slot. |
Permissions¶
| Role | Allow |
|---|---|
| Application Viewer | Yes |
| Application Manager | Yes |
| Application Creator | Yes |
| Application Editor | Yes |
| Global Application Viewer | Yes |
| Global Application Manager | Yes |
Examples¶
GET to retrieve application services summary for an application¶
Following is an example of a response to the default API call, with only the required $appId parameter.
GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/ApplicationServicesSummary?$appId=7439f32a-8cc6-3cb3-8e6a-aee4e71a4191
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 206082687039,
"result": {
"dnsUnhandledRpsTs": [
{
"timeMillis": 1563782100000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563782400000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563782700000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563783000000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563783300000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563783600000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563783900000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563784200000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563784500000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563784800000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563785100000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563785400000,
"count": 0,
"dnsUnhandledRps": 0.0
},
{
"timeMillis": 1563785520000,
"count": 0,
"dnsUnhandledRps": 0.0
}
],
"dnsUnhandledRps": 0.0,
"dnsTotalRpsTs": [
{
"timeMillis": 1563782100000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563782400000,
"count": 0,
"dnsTotalRps": 0.006666666666666667
},
{
"timeMillis": 1563782700000,
"count": 0,
"dnsTotalRps": 0.006666666666666667
},
{
"timeMillis": 1563783000000,
"count": 0,
"dnsTotalRps": 0.02
},
{
"timeMillis": 1563783300000,
"count": 0,
"dnsTotalRps": 0.006666666666666667
},
{
"timeMillis": 1563783600000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563783900000,
"count": 0,
"dnsTotalRps": 0.006666666666666667
},
{
"timeMillis": 1563784200000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563784500000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563784800000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563785100000,
"count": 0,
"dnsTotalRps": 0.006666666666666667
},
{
"timeMillis": 1563785400000,
"count": 0,
"dnsTotalRps": 0.013333333333333334
},
{
"timeMillis": 1563785520000,
"count": 0,
"dnsTotalRps": 0.016666666666666666
}
],
"dnsTotalRps": 0.016666666666666666,
"health": {
"Critical": 0,
"Moderate": 1,
"Good": 1,
"Other": 1
},
"numOfAppsNotProtected": 3,
"numOfAppsWithBadTrafficGrowth": 0,
"numOfAppsWithBlockingValidTraffic": 0,
"numOfAppsWithSuccessfulAttacks": 0,
"totalApplications": 3,
"concurrent-connections": [
{
"application": "boston_MyWebApp217",
"concurrent-connections": 0.24444444444444444
},
{
"application": "seattle_MyWebApp218",
"concurrent-connections": 0.0
}
],
"http-tps": [
{
"application": "boston_MyWebApp217",
"http-tps": 0.2
},
{
"application": "seattle_MyWebApp218",
"http-tps": 0.12222222222222222
}
],
"response-time": [
{
"application": "seattle_MyWebApp218",
"response-time": 0.45454545454545453
},
{
"application": "boston_MyWebApp217",
"response-time": 0.0
}
]
},
"requestDurationInMillis": 448
}