SSLO Services Summary

Overview

This BIG-IQ API can get the summary data for all SSL Orchestrator (SSLO) services.

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

Requests

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

Query Parameters

The following parameters can be used as OData query options with this API.

Name Type Required Description
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.

Request Parameters

None

Response

HTTP/1.1 200 OK

The JSON in the response can include the following parameters.

Name Type Description
connections object List of devices with their respective greatest number of concurrent connections
     <device name> string Greatest number of concurrent connections
servicesHealth object Number of services by respective health status
     critical number Number of services having a health of “Critical”
     good number Number of services having a health of “Good”.
     moderate number Number of services having a health of “Moderate”
     other number Number of objects having a health of “Other”
throughputIn object List of devices with their respective greatest throughput in
     <device name> string Greatest value of throughput in
throughputOut object List of devices with their respective greatest throughput out
     <device name> string Greatest value of throughput out
totalServices number Number of all SSLO services

Permissions

Role Allow
SSL Orchestrator Manager Yes

Examples

GET to retrieve data for all SSLO services

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

Response

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 1046482564480,
    "result": {
            "totalServices": 1,
            "servicesHealth": {
                    "Critical": 1,
                    "Moderate": 0,
                    "Good": 0,
                    "Other": 0
            },
            "throughputIn": {
                    "ssloS_icapService": 2313.21
            },
            "throughputOut": {
                    "ssloS_icapService": 45789.14
            },
            "connections": {
                    "ssloS_icapService": 1
            }
    },
    "requestDurationInMillis": 109

}