Service Scaling Group List¶

Overview¶

A list of all service scaling groups (SSGs) managed by BIG-IQ.

REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/AllServiceScalingGroupsList¶

Requests¶

GET /mgmt/ap/query/v1/tenants/default/reports/AllServiceScalingGroupsList¶

Query Parameters¶

Name	Type	Required	Description
filter	string	False	Specifies a string or integer used to filter the results. You can filter based on one or more parameters.
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.
orderby	string	False	Specifies the sorting parameter and order to apply to results. You can sort by health, name, activeAlerts, activeDevices, lastModified, averageCpuUsage, averageMemoryUsage, throughputIn and throughputOut. The sort order can be ascending (asc) or descending (desc). The default value is “health desc”, which sorts by health in descending order.
skip	number	False	Specifies the number of results in the ordered list to skip. The default value of skip is 0, meaning none are skipped and the results range from 1 to the top value.
to	query option	now	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.
top	number	False	Specify the maximum number of results in the ordered list. The default value is 10.

Response¶

HTTP/1.1 200 OK

Name	Type	Description
items	object	The items that appear in the query.
activeAlerts	number	The number of alerts to an SSG that are currently active
activeApplications	number	The number of applications supported by the SSG.
activeDevices	number	The current number of BIG-IPs in the SSG.
averageCpuUsage	number	The average CPU usage detected the past five minutes.
averageMemoryUsage	number	The average memory usage detected over the past five minutes.
health	HealthEnum	The current health of the SSG
id	string	The Service Scaling Group’s unique identifier.
lastModified	number	The time in which changes were last made to the SSG configuration.
maxConfiguredDevices	number	The max limit of BIG-IPs that can be configured to an SSG.
maxSupportedApplications	number	The max limit of applications that can be supported by an SSG.
name	string	The SSG’s name.
status	string	The current status of the SSG. Possible values: “DELETING”, “LAUNCHING”, “OFFLINE”, “PAUSED”, “READY” or “REDEPLOYING”.
throughputIn	number	The average throughput in to the SSG over the past five minutes.
throughputOut	number	The average throughput out of the SSG over the past five minutes.
transactionsPerSecond	number	The average number of transactions per second over the past five minutes.
itemsPerPage	number	The number of items per page.
pageIndex	number	The chronological page number as of which to display query results.
startIndex	number	The chronological item number as of which to display query results.
total	number	The total number of items queried.
totalPages	number	The total number of pages in the query result.

Permissions¶

Role	Allow
Security Manager	Yes

Examples¶

GET to retrieve a list of all SSGs¶

The following example returns the top 50 items ordered by health state in ascending order.

GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/AllServiceScalingGroupsList?$orderby=health asc&$skip=0&$top=50

Response¶

{
    "kind": "ap:compose:Report",
    "lastUpdateMicros": 320280501316,
    "result": {
            "totalItems": 2,
            "items": [{
                    "id": "2188f20a-5014-30e0-8d5d-77e7cda08351",
                    "name": "Automation-01Ssg4",
                    "status": "READY",
                    "lastModified": 1551064024774,
                    "maxConfiguredDevices": 3,
                    "activeDevices": 1,
                    "averageCpuUsage": 6.382063627243042,
                    "averageMemoryUsage": 9.0,
                    "transactionsPerSecond": 0.19444444444444445,
                    "throughputIn": 1373.4833333333333,
                    "throughputOut": 1104.9222222222222,
                    "activeAlerts": 2,
                    "health": "Good"
            }, {
                    "id": "1f4e9954-7c50-38b6-ac8c-4c9a1068feb1",
                    "name": "Automation-01Ssg5",
                    "status": "READY",
                    "lastModified": 1551064804777,
                    "maxConfiguredDevices": 3,
                    "activeDevices": 1,
                    "averageCpuUsage": 5.6360988318920135,
                    "averageMemoryUsage": 9.0,
                    "transactionsPerSecond": 0.0,
                    "throughputIn": 635.25,
                    "throughputOut": 483.2888888888889,
                    "activeAlerts": 2,
                    "health": "Good"
            }],
            "itemsPerPage": 0,
            "startIndex": 0,
            "totalPages": 0,
            "pageIndex": 0,
            "currentItemCount": 2
    },
    "requestDurationInMillis": 269
}

Previous Next