SSLO Per Service Summary¶
Overview¶
This BIG-IQ API can get a summary overview of a SSL Orchestrator (SSLO) service.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/SsloPerServiceSummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/SsloPerServiceSummary¶
Query Parameters¶
The following parameters can be used as OData query options with this API.
| Name | Type | Required | Description |
|---|---|---|---|
| service | string | True | Specifies the name of the SSLO service. |
Request Parameters¶
None
Response¶
HTTP/1.1 200 OK
The JSON in the response can include the following parameters.
| Name | Type | Description |
|---|---|---|
| activeAlerts | object | List of the topology’s active alerts |
| id | string | Alert’s unique identifier |
| severity | string | Severity of the alert |
| timestamp | number | Time when the alert was updated |
| title | string | Short description of the alert |
| alertsHistory | object | List of the topology’s alerts history |
| id | string | Alert’s unique identifier |
| severity | string | Severity of the alert |
| timestamp | number | Time when the alert was updated |
| title | string | Short description of the alert |
| connections | number | Current average number of concurrent connections |
| connectionsTs | object | List of the average number of concurrent connections for the respective time sub-intervals |
| count | number | Number of data samples collected in this time sub-interval. |
| <changing value fields> | object | Values calculated for this time sub-interval |
| timeMillis | number | End time of this time sub-interval |
| health | object | The topology’s health. Possible values: “Critical”, “Moderate”, “Good” or “Other” |
| name | string | Service’s readable name |
| throughputStats | object | Current average number of throughput statistics |
| <changing value fields> | object | Average values for the entire time interval |
| throughputStatsTs | object | List of the average number of throughput statistics for the respective time sub-intervals |
| count | number | Number of data samples collected during this time sub-interval |
| <changing value fields> | object | Values calculated for this time sub-interval |
| timeMillis | number | Ending time of this time sub-interval |
Permissions¶
| Role | Allow |
|---|---|
| SSL Orchestrator Manager | Yes |
Examples¶
GET to retrieve a topology detailed summary¶
GET /mgmt/ap/query/v1/tenants/default/reports/SsloPerServiceSummary?$service=ssloS_Service1
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 185254048628,
"result": {
"name": "ssloS_Service1",
"health": "Good",
"throughputStats": {
"throughputIn": 0,
"throughputOut": 156.5
},
"connections": 4,
"throughputStatsTs": [{
"timeMillis": 1563273000000,
"count": 0,
"throughputIn": 0,
"throughputOut": 156.66666666666666
},
{
"timeMillis": 1563273300000,
"count": 0,
"throughputIn": 0,
"throughputOut": 160.2
},
{
"timeMillis": 1563273600000,
"count": 0,
"throughputIn": 0,
"throughputOut": 158.06666666666666
},
{
"timeMillis": 1563273900000,
"count": 0,
"throughputIn": 0,
"throughputOut": 159.66666666666666
},
{
"timeMillis": 1563274200000,
"count": 0,
"throughputIn": 0,
"throughputOut": 159.6
},
{
"timeMillis": 1563274500000,
"count": 0,
"throughputIn": 0,
"throughputOut": 158.4
},
{
"timeMillis": 1563274800000,
"count": 0,
"throughputIn": 0,
"throughputOut": 158.73333333333332
},
{
"timeMillis": 1563275100000,
"count": 0,
"throughputIn": 0,
"throughputOut": 159.66666666666666
},
{
"timeMillis": 1563275400000,
"count": 0,
"throughputIn": 0,
"throughputOut": 155.86666666666667
},
{
"timeMillis": 1563275700000,
"count": 0,
"throughputIn": 0,
"throughputOut": 160.6
},
{
"timeMillis": 1563276000000,
"count": 0,
"throughputIn": 0,
"throughputOut": 158.06666666666666
},
{
"timeMillis": 1563276300000,
"count": 0,
"throughputIn": 0,
"throughputOut": 160.86666666666667
},
{
"timeMillis": 1563276540000,
"count": 0,
"throughputIn": 0,
"throughputOut": 156.5
}
],
"connectionsTs": [{
"timeMillis": 1563273000000,
"count": 0,
"connections": 4.1
},
{
"timeMillis": 1563273300000,
"count": 0,
"connections": 4.1
},
{
"timeMillis": 1563273600000,
"count": 0,
"connections": 4.1
},
{
"timeMillis": 1563273900000,
"count": 0,
"connections": 3.9
},
{
"timeMillis": 1563274200000,
"count": 0,
"connections": 3.9
},
{
"timeMillis": 1563274500000,
"count": 0,
"connections": 4.3
},
{
"timeMillis": 1563274800000,
"count": 0,
"connections": 3.9
},
{
"timeMillis": 1563275100000,
"count": 0,
"connections": 3.4
},
{
"timeMillis": 1563275400000,
"count": 0,
"connections": 3.9
},
{
"timeMillis": 1563275700000,
"count": 0,
"connections": 4.2
},
{
"timeMillis": 1563276000000,
"count": 0,
"connections": 4.1
},
{
"timeMillis": 1563276300000,
"count": 0,
"connections": 4.1
},
{
"timeMillis": 1563276540000,
"count": 0,
"connections": 4
}
],
"activeAlerts": [],
"alertsHistory": []
},
"requestDurationInMillis": 365
}