v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22216424765.0 KB

gateway.openapi_Gateway

Get Node Pool Stats

get/v1/accounts/{account_id}/nodePools/{node_pool_id}:getStats

Path parameters

account_idstring required

The Account Id

node_pool_idstring required

The Node Pool Id

Query parameters

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

nodeCountinteger

The number of nodes currently available in this pool.

ranksPerNodeinteger

The number of ranks available per node. This is determined by the machine type of the nodes in this node pool.

environmentCountinteger

The number of environments connected to this node pool.

environmentRanksinteger

The number of ranks in this node pool that are currently allocated to environment connections.

batchJobCountobject

The key is the string representation of BatchJob.State (e.g. "RUNNING"). The value is the number of batch jobs in that state allocated to this node pool.

batchJobRanksobject

The key is the string representation of BatchJob.State (e.g. "RUNNING"). The value is the number of ranks allocated to batch jobs in that state in this node pool.