> ## 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.

# Get kubernetes cluster workload container metrics

> Returns time-series for a single workload container - CPU usage, memory usage, CPU throttle ratio, PVC disk read, write and aggregated throughput, and PVC disk read, write and aggregated IOPS - pooled across the workload's replicas, and, where the accelerator exporter attributes a device to this container, the device's utilisation, memory and power, how many devices the container holds, and whether it holds them exclusively, for the tenant selected by the X-CostGraph-Tenant-ID header



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/clusters/{cluster_id}/workloads/{resource_id}/containers/{container_name}/metrics
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: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: infracost
    x-group: Infracost
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - 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: service-map
    x-group: Service map
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - 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}/workloads/{resource_id}/containers/{container_name}/metrics:
    get:
      tags:
        - kubernetes-clusters
      summary: Get kubernetes cluster workload container metrics
      description: >-
        Returns time-series for a single workload container - CPU usage, memory
        usage, CPU throttle ratio, PVC disk read, write and aggregated
        throughput, and PVC disk read, write and aggregated IOPS - pooled across
        the workload's replicas, and, where the accelerator exporter attributes
        a device to this container, the device's utilisation, memory and power,
        how many devices the container holds, and whether it holds them
        exclusively, for the tenant selected by the X-CostGraph-Tenant-ID header
      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: Kubernetes workload resource ID
          name: resource_id
          in: path
          required: true
          schema:
            type: string
        - description: Container name
          name: container_name
          in: path
          required: true
          schema:
            type: string
        - description: Time window (e.g. 1h, 24h, 7d). Default 1h
          name: range
          in: query
          schema:
            type: string
        - description: Resolution step
          name: step
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/k8scluster.WorkloadContainerMetrics
        '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
    k8scluster.WorkloadContainerMetrics:
      type: object
      required:
        - api_version
        - container_name
        - cpu_throttle
        - cpu_usage
        - end
        - gpu_availability
        - gpu_memory_used_mib
        - gpu_memory_utilization
        - gpu_power_utilization
        - gpu_power_watts
        - gpu_utilization
        - iops
        - memory_usage
        - namespace
        - read_iops
        - read_throughput
        - resource_id
        - start
        - step_seconds
        - throughput
        - workload_kind
        - workload_name
        - write_iops
        - write_throughput
      properties:
        api_version:
          type: string
        container_name:
          type: string
        cpu_throttle:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        cpu_usage:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        end:
          type: string
        gpu_availability:
          type: object
          additionalProperties:
            type: string
        gpu_device_exclusive:
          type: boolean
          nullable: true
        gpu_devices_held:
          type: integer
        gpu_identity_source:
          type: string
        gpu_memory_used_mib:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        gpu_memory_utilization:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        gpu_power_utilization:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        gpu_power_watts:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        gpu_utilization:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        iops:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        memory_usage:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        namespace:
          type: string
        read_iops:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        read_throughput:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        resource_id:
          type: string
        start:
          type: string
        step_seconds:
          type: integer
        throughput:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        workload_kind:
          type: string
        workload_name:
          type: string
        write_iops:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        write_throughput:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    metrics.MetricPoint:
      type: object
      required:
        - t
        - v
      properties:
        t:
          type: integer
        v:
          type: number
  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.