Sign in
Dashboard

Per-pool cluster resource-usage snapshot for the active tenant

Changed on
get/api/v1/dashboard/cluster-usage

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/dashboard/cluster-usage
  • Auth: none declared

Query parameters

poolstring

Restrict to a single resource pool; omit for every pool the tenant has quota in.

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Response

Cluster usage snapshot.

partialboolean

True when one or more pools could not be sampled and were omitted from the snapshot.

updatedAtstring date-time required

Time the snapshot was sampled.

Example response

{
  "pools": [
    {
      "meters": [
        {
          "resource": "gpu",
          "total": 32,
          "unit": "cards",
          "used": 22
        },
        {
          "resource": "cpu",
          "total": 384,
          "unit": "cores",
          "used": 240
        },
        {
          "resource": "memory",
          "total": 2048,
          "unit": "GiB",
          "used": 1228.8
        }
      ],
      "pool": "gpu-a100"
    },
    {
      "meters": [
        {
          "resource": "gpu",
          "total": 16,
          "unit": "cards",
          "used": 14
        },
        {
          "resource": "cpu",
          "total": 256,
          "unit": "cores",
          "used": 180
        },
        {
          "resource": "memory",
          "total": 2048,
          "unit": "GiB",
          "used": 1433.6
        }
      ],
      "pool": "h100-pool"
    },
    {
      "meters": [
        {
          "resource": "gpu",
          "total": 0,
          "unit": "cards",
          "used": 0
        },
        {
          "resource": "cpu",
          "total": 512,
          "unit": "cores",
          "used": 320
        },
        {
          "resource": "memory",
          "total": 1536,
          "unit": "GiB",
          "used": 819.2
        }
      ],
      "pool": "cpu-pool"
    }
  ],
  "updatedAt": "2026-06-28T09:30:00Z"
}

Changes

  • b96f9c343aa0Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the new optional header request parameter X-Axisml-Tenant

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

  • e93e8e490641Revision changes
    • info

      endpoint added