> ## Documentation Index
> Fetch the complete documentation index at: https://docs.costgraph.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List kubernetes cluster node pool workloads

> Returns, per workload with containers running on this pool's nodes, its slice on the pool: average CPU cores and memory GiB used and requested over the period, and its cost on the pool, largest cost first, one page at a time. A workload's pods spread across pools, so a row is only the part that ran on this pool and a cross-pool workload also appears on the other pools' lists. cpu and memory are averaged over the period; monthly_cost_usd projects the pool-rate cost of that usage over a 730-hour month and is null when the pool's nodes could not be priced. would_autopilot_move is true when AutoPilot has an open placement moving the workload off this pool. Pool membership follows each container's current node. from and to are RFC 3339 and truncated to the hour, to is exclusive; the default is the last 30 days ending at the last closed hour; a period over 400 days is rejected.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/clusters/{cluster_id}/node-pools/workloads
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: context-graph
    x-group: Context graph
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network
    x-group: Network
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: sandboxes
    x-group: Sandboxes
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: ticketing
    x-group: Ticketing
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/tenant/clusters/{cluster_id}/node-pools/workloads:
    get:
      tags:
        - kubernetes-clusters
      summary: List kubernetes cluster node pool workloads
      description: >-
        Returns, per workload with containers running on this pool's nodes, its
        slice on the pool: average CPU cores and memory GiB used and requested
        over the period, and its cost on the pool, largest cost first, one page
        at a time. A workload's pods spread across pools, so a row is only the
        part that ran on this pool and a cross-pool workload also appears on the
        other pools' lists. cpu and memory are averaged over the period;
        monthly_cost_usd projects the pool-rate cost of that usage over a
        730-hour month and is null when the pool's nodes could not be priced.
        would_autopilot_move is true when AutoPilot has an open placement moving
        the workload off this pool. Pool membership follows each container's
        current node. from and to are RFC 3339 and truncated to the hour, to is
        exclusive; the default is the last 30 days ending at the last closed
        hour; a period over 400 days is rejected.
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Kubernetes cluster ID
          name: cluster_id
          in: path
          required: true
          schema:
            type: string
        - description: Autoscaler that runs the pool
          name: pool_autoscaler
          in: query
          required: true
          schema:
            type: string
        - description: Node pool name
          name: pool
          in: query
          required: true
          schema:
            type: string
        - description: Period start (RFC 3339, inclusive)
          name: from
          in: query
          schema:
            type: string
        - description: Period end (RFC 3339, exclusive)
          name: to
          in: query
          schema:
            type: string
        - description: Number of rows to return (default 50, max 200)
          name: limit
          in: query
          schema:
            type: integer
        - description: Rows to skip before returning results (default 0)
          name: offset
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/operator.NodePoolWorkloadList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    operator.NodePoolWorkloadList:
      type: object
      required:
        - from
        - items
        - limit
        - offset
        - to
        - total_count
      properties:
        from:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/operator.NodePoolWorkload'
        limit:
          type: integer
        offset:
          type: integer
        to:
          type: string
        total_count:
          type: integer
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    operator.NodePoolWorkload:
      type: object
      required:
        - cpu_cores_requested
        - cpu_cores_used
        - id
        - kind
        - memory_gib_requested
        - memory_gib_used
        - name
        - namespace
        - replicas
        - would_autopilot_move
      properties:
        cpu_cores_requested:
          type: number
        cpu_cores_used:
          type: number
        id:
          type: string
          x-semantic: resourceId
        kind:
          type: string
        memory_gib_requested:
          type: number
        memory_gib_used:
          type: number
        monthly_cost_usd:
          type: number
          x-semantic: costAmount
          nullable: true
        name:
          type: string
        namespace:
          type: string
        replicas:
          type: integer
        would_autopilot_move:
          type: boolean
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.