Get host pool statistics

get

https://api.controlup.com/daas-iq/v1/cloud/host-pools/statistics

Returns six organization-wide totals: pooled and personal pool counts, available and draining session host counts,
and active and total session counts, across all pools matching the optional provider and filter criteria.
No per-pool rows, so a total cannot be traced back to the pools behind it, but far cheaper than paging the list.

Query Params

provider

string

enum

Optional cloud provider filter. Null means all providers.

Allowed:

filter

string

length ≤ 512

Filter expression for filtering results.

Supports JSON and RQL formats:

JSON: {"and":[{"field":"status","op":"eq","value":"Active"},{"field":"name","op":"ct","value":"Smith, John"}]}
RQL: and(eq(status,Active),ct(name,Smith%2C%20John)) — values are URL-decoded; encode reserved characters

Operators:
and, or, not (logical); eq, neq, ct, nct, sw, nsw, ew, new, gt, gte, lt, lte (predicate)

Fields (names are matched case-insensitively):
activeSessions, assignmentType, avgCpuPercent, hasNativeScalingPlan, hasSessionHostConfig, id, name, provider, region, regionId, resourceGroup, resourceGroupId, runningHosts, stoppedHosts, subscription, subscriptionId, syncedAt, totalHosts, totalSessions, type

Responses

200Successfully retrieved host pool statistics.

400Bad request. Invalid filter parameters.

401Unauthorized. User is not authenticated.

402Payment required. No active license for the organization.

403Forbidden. User does not have access to this organization.

500Internal server error.

503Service unavailable. License status could not be verified. Try again later.