Clusters - TypeScript SDK
client.clusters exposes caller-visible capacity. Capacity values are
admission snapshots, not reservations.
Overview
Available Operations
| Method | Description |
|---|---|
list() | List clusters visible to the caller. |
capacity(clusterId) | List placement-level capacity in one cluster. |
holds(options?) | List active workload resource holds, optionally by cluster. |
timeseries(clusterId, options?) | Read recent capacity snapshots. |
list
List clusters visible to the caller.
Request
This method has no parameters and sends no request body.
Response
UserClusterCapacityVO[].
capacity
List placement-level capacity in one cluster.
Request
clusterId: number | string required.
Response
UserNodeCapacityVO[].
holds
List active workload resource holds, optionally by cluster.
Request
Optional {clusterId}.
Response
UserWorkloadHoldVO[].
timeseries
Read recent capacity snapshots.
Request
clusterId required; optional {limit}.
Response
UserCapacitySnapshotVO[].
Field Reference and Examples
Key response fields
| Type | Fields |
|---|---|
UserClusterCapacityVO | clusterId, name, status, selectable, known, fresh, snapshotAt, entitled, held, quotaAvailable, deficit, nodeCount |
UserNodeCapacityVO | placementAlias, entitled, held, quotaAvailable, deficit |
UserWorkloadHoldVO | businessType, businessId, displayName, clusterId, state, requests, canStop, createdAt |
UserCapacitySnapshotVO | snapshotTime, sourceEventType, entitled, held, quotaAvailable, deficit |
const clusters = await client.clusters.list();
const nodes = await client.clusters.capacity(1);
const allHolds = await client.clusters.holds();
const clusterHolds = await client.clusters.holds({ clusterId: 1 });
const history = await client.clusters.timeseries(1, { limit: 60 });
All methods use the shared authentication and typed error behavior described in Response Conventions and Retry and Security.