Clusters - Python SDK
client.clusters exposes caller-visible cluster capacity. Capacity values are
admission snapshots, not reservations.
Overview
Available Operations
| Method | Description |
|---|---|
list() | List clusters visible to the caller. |
capacity(cluster_id) | List placement-level capacity in one cluster. |
holds(cluster_id=None) | List active workload resource holds, optionally by cluster. |
timeseries(cluster_id, limit=None) | Read recent capacity snapshots. |
list
List clusters visible to the caller.
Request
This method has no parameters and sends no request body.
Response
list[UserClusterCapacityVO].
capacity
List placement-level capacity in one cluster.
Request
cluster_id: int | str (required).
Response
list[UserNodeCapacityVO].
holds
List active workload resource holds, optionally by cluster.
Request
cluster_id: int | str | None.
Response
list[UserWorkloadHoldVO].
timeseries
Read recent capacity snapshots.
Request
cluster_id required; limit: int | None.
Response
list[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 |
clusters = client.clusters.list()
nodes = client.clusters.capacity(cluster_id=1)
all_holds = client.clusters.holds()
cluster_holds = client.clusters.holds(cluster_id=1)
history = client.clusters.timeseries(cluster_id=1, limit=60)
All methods use the shared authentication and typed error behavior described in Response Conventions and Retry and Security.