Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
nodePools
/
{node_pool_id}
:getStats
Get Node Pool Stats
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/nodePools/{node_pool_id}:getStats \
  --header 'Authorization: Bearer <token>'
{
  "nodeCount": 123,
  "ranksPerNode": 123,
  "environmentCount": 123,
  "environmentRanks": 123,
  "batchJobCount": {},
  "batchJobRanks": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

​
account_id
string
required

The Account Id

​
node_pool_id
string
required

The Node Pool Id

Query Parameters

​
readMask
string

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

Response

200 - application/json

A successful response.

​
nodeCount
integer<int32>

The number of nodes currently available in this pool.

​
ranksPerNode
integer<int32>

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

​
environmentCount
integer<int32>

The number of environments connected to this node pool.

​
environmentRanks
integer<int32>

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

​
batchJobCount
object

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.

​
batchJobRanks
object

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.