SSLO Per Topology Summary¶
Overview¶
This BIG-IQ API can get a summary overview of a SSL Orchestrator (SSLO) topology.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/SsloPerTopologySummary¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/SsloPerTopologySummary¶
Query Parameters¶
The following parameters can be used as OData query options with this API.
| Name | Type | Required | Description |
|---|---|---|---|
| topology | string | False | Specifies the name of the SSLO topology for which data is requested. |
Request Parameters¶
None
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 | Alert’s severity |
| 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 | Alert’s severity |
| timestamp | number | Time when the alert was updated |
| title | string | Short description of the alert. |
| allowedHitCountStats | number | Current number of allowed transactions |
| allowedHitCountStatsTs | object | List of the average number of allowed transactions |
| count | number | Number of data samples collected in the time sub-interval |
| <changing value fields> | object | Value calculated for the time sub-interval |
| timeMillis | number | End time of the time sub-interval |
| blockedHitCountStats | number | Current number of blocked transactions |
| blockedHitCountStatsTs | object | List of the average number of blocked transactions over time |
| timeMillis | number | End time of the time sub-interval |
| count | number | Number of data samples collected in the time interval |
| <changing value fields> | object | Value calculated for the time sub-interval |
| name | string | Topology’s readable name |
| throughputStats | number | Current number of throughput statistics |
| throughputStatsTs | object | List of the average number of throughput statistics |
| count | number | Number of data samples collected in the time sub-interval |
| <changing value fields> | object | Value calculated for the time sub-interval |
| timeMillis | number | End time of the time sub-interval. |
| topClientCipher | object | List of client cipher names with their respective greatest SSLO transactions per second over the past five minutes |
| <client cipher name> | number | Greatest SSLO transactions per second over the past five minutes |
| topServerCipher | object | A list of server cipher names with respective greatest SSLO transactions per second over the past five minutes. |
| <server cipher name> | number | Greatest SSLO transactions per second over the past five minutes |
| health | object | The topology’s health |
| Critical | string | The object’s health is critical. |
| Good | string | The object’s health is good. |
| Moderate | string | The object’s health is moderate. |
| Other | string | The object’s health is unknown. |
Permissions¶
| Role | Allow |
|---|---|
| SSL Orchestrator Manager | Yes |
Examples¶
GET to retrieve a topology detailed summary¶
Following is an example of a response to the API call.
GET /mgmt/ap/query/v1/tenants/default/reports/SsloPerTopologySummary?$topology=sslo_Topology1
Response¶
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 183099514104,
"result": {
"name": "sslo_Topology1",
"health": "Good",
"throughputStats": 361362461.10952383,
"throughputStatsTs": [{
"timeMillis": 1563270900000,
"count": 10,
"throughputIn": 361175863.17333335
},
{
"timeMillis": 1563271200000,
"count": 10,
"throughputIn": 362441446.83666664
},
{
"timeMillis": 1563271500000,
"count": 10,
"throughputIn": 358876705.69
},
{
"timeMillis": 1563271800000,
"count": 10,
"throughputIn": 357728184.06
},
{
"timeMillis": 1563272100000,
"count": 10,
"throughputIn": 358993780.73333335
},
{
"timeMillis": 1563272400000,
"count": 10,
"throughputIn": 363889740.25
},
{
"timeMillis": 1563272700000,
"count": 10,
"throughputIn": 359114689.74666667
},
{
"timeMillis": 1563273000000,
"count": 10,
"throughputIn": 357961449.74666667
},
{
"timeMillis": 1563273300000,
"count": 10,
"throughputIn": 361651311.1566667
},
{
"timeMillis": 1563273600000,
"count": 10,
"throughputIn": 355662820.21
},
{
"timeMillis": 1563273900000,
"count": 10,
"throughputIn": 361768878.45666665
},
{
"timeMillis": 1563274200000,
"count": 10,
"throughputIn": 363036332.11333334
},
{
"timeMillis": 1563274410000,
"count": 7,
"throughputIn": 361362461.10952383
}
],
"allowedHitCountStats": 0.9952380952380953,
"allowedHitCountStatsTs": [{
"timeMillis": 1563270900000,
"count": 10,
"actionAllowed": 0.9966666666666667
},
{
"timeMillis": 1563271200000,
"count": 10,
"actionAllowed": 1
},
{
"timeMillis": 1563271500000,
"count": 10,
"actionAllowed": 0.99
},
{
"timeMillis": 1563271800000,
"count": 10,
"actionAllowed": 0.9866666666666667
},
{
"timeMillis": 1563272100000,
"count": 10,
"actionAllowed": 0.99
},
{
"timeMillis": 1563272400000,
"count": 10,
"actionAllowed": 1.0033333333333334
},
{
"timeMillis": 1563272700000,
"count": 10,
"actionAllowed": 0.99
},
{
"timeMillis": 1563273000000,
"count": 10,
"actionAllowed": 0.9866666666666667
},
{
"timeMillis": 1563273300000,
"count": 10,
"actionAllowed": 0.9966666666666667
},
{
"timeMillis": 1563273600000,
"count": 10,
"actionAllowed": 0.98
},
{
"timeMillis": 1563273900000,
"count": 10,
"actionAllowed": 0.9966666666666667
},
{
"timeMillis": 1563274200000,
"count": 10,
"actionAllowed": 1
},
{
"timeMillis": 1563274410000,
"count": 7,
"actionAllowed": 0.9952380952380953
}
],
"blockedHitCountStats": 0,
"blockedHitCountStatsTs": [{
"timeMillis": 1563270900000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563271200000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563271500000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563271800000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563272100000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563272400000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563272700000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563273000000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563273300000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563273600000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563273900000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563274200000,
"count": 0,
"actionBlocked": 0
},
{
"timeMillis": 1563274410000,
"count": 0,
"actionBlocked": 0
}
],
"topClientCipher": {
"ECDHE-RSA-AES128-GCM-SHA256": 0.9933333333333333
},
"topServerCipher": {
"ECDHE-RSA-AES128-GCM-SHA256": 0.9933333333333333
},
"activeAlerts": [],
"alertsHistory": []
},
"requestDurationInMillis": 344
}