Kubernetes

Get Kubernetes efficiency

GET

https://api.costfluent.com

/v1/kubernetes/efficiency

Bearer (API token)

Returns the cost, idle cost and CPU and memory used and peak over requested of the workspace's Kubernetes clusters over a window, per cluster, namespace or workload, largest cost first. It reads the clusters' own rows, never the cloud connection's, and returns at most 500 rows.

Needs a token with viewCosts on the workspace.

Get Kubernetes efficiency › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

startDate

string · date · required

endDate

string · date · required

level

string · required

filter

string | null

Get Kubernetes efficiency › Responses

Success

KubernetesEfficiencyResponse

level

KubernetesEfficiencyLevel · required

KubernetesEfficiencyRowResponse[] · required

truncated

boolean · required

CurrencyAmount[] · required

currency

string | null · pattern: ^[A-Z]{3}$

historyFloor

string | null · date

GET/v1/kubernetes/efficiency

curl 'https://api.costfluent.com/v1/kubernetes/efficiency?workspaceId=<string>&startDate=<string>&endDate=<string>&level=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "currency": "currency",
  "level": "level",
  "rows": [
    {
      "cluster": "cluster",
      "namespace": "namespace",
      "workload": "workload",
      "cost": "cost",
      "idleCost": "idleCost",
      "cpu": {
        "requested": 0,
        "used": 0,
        "peak": 0,
        "usedPercent": 0,
        "peakPercent": 0
      },
      "memory": {
        "requested": 0,
        "used": 0,
        "peak": 0,
        "usedPercent": 0,
        "peakPercent": 0
      }
    }
  ],
  "truncated": true,
  "historyFloor": "2024-08-25",
  "unconverted": [
    {
      "currency": "currency",
      "amount": "amount"
    }
  ]
}

json

application/json

Report Kubernetes usage

POST

https://api.costfluent.com

/v1/kubernetes/reports

Bearer (API token)

Accepts one aggregated window from the Costfluent Kubernetes agent, as JSON, gzip-compressed with Content-Encoding: gzip, with the token of the cluster it reports for. A cluster is added in Costfluent before its first report, and its token reports for it alone: another cluster_id, or any token that is not a cluster token, is refused with 403. A schema_version this API does not read, newer than it knows or retired, is answered 422 rather than refused as invalid, so the agent keeps the report and retries it.

Needs an organization token with reportKubernetesUsage.

Report Kubernetes usage › Request Body

KubernetesReport

schema_version

integer · int32

cluster_id

string

agent_version

string

agent_instance_id

string

window_start

string · date-time

window_end

string · date-time

object | null

KubernetesReportNode[]

KubernetesReportPod[]

array | null

Report Kubernetes usage › Responses

Accepted

KubernetesReportAcceptedResponse

id

K8sClusterPublicId · pattern: ^k8s_[A-Za-z0-9_-]{2… · required

cluster_id

string · required

status

K8sClusterStatus · required

POST/v1/kubernetes/reports

curl https://api.costfluent.com/v1/kubernetes/reports \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "schema_version": 0,
  "cluster_id": "cluster_id",
  "agent_version": "agent_version",
  "agent_instance_id": "agent_instance_id",
  "window_start": "2024-08-25T15:00:00Z",
  "window_end": "2024-08-25T15:00:00Z",
  "unscraped_nodes": {
    "key": 0
  },
  "nodes": [
    {
      "name": "name",
      "provider_id": "provider_id",
      "instance_type": "instance_type",
      "region": "region",
      "zone": "zone",
      "spot": true,
      "observed_seconds": 0,
      "capacity_cpu_cores": 0,
      "capacity_memory_bytes": 0,
      "capacity_gpu": 0,
      "gpu_resources": {
        "key": 0
      },
      "allocatable_cpu_cores": 0,
      "allocatable_memory_bytes": 0,
      "labels": {
        "key": "string"
      },
      "annotations": {
        "key": "string"
      },
      "gpu_labels": {
        "key": "string"
      }
    }
  ],
  "pods": [
    {
      "namespace": "namespace",
      "name": "name",
      "node": "node",
      "controller_kind": "controller_kind",
      "controller": "controller",
      "labels": {
        "key": "string"
      },
      "annotations": {
        "key": "string"
      },
      "namespace_labels": {
        "key": "string"
      },
      "containers": [
        {
          "name": "name",
          "observed_seconds": 0,
          "cpu_request_cores": 0,
          "memory_request_bytes": 0,
          "gpu_request": 0,
          "gpu_requests": {
            "key": 0
          },
          "cpu_usage_core_seconds": 0,
          "memory_usage_byte_seconds": 0,
          "cpu_allocated_core_seconds": 0,
          "memory_allocated_byte_seconds": 0,
          "cpu_usage_peak_cores": 0,
          "memory_usage_peak_bytes": 0
        }
      ],
      "claims": [
        "string"
      ]
    }
  ],
  "volumes": [
    {
      "name": "name",
      "capacity_bytes": 0,
      "storage_class": "storage_class",
      "csi_driver": "csi_driver",
      "volume_handle": "volume_handle",
      "phase": "phase",
      "claim_namespace": "claim_namespace",
      "claim_name": "claim_name",
      "observed_seconds": 0,
      "storage_class_annotations": {
        "key": "string"
      },
      "claim_labels": {
        "key": "string"
      }
    }
  ]
}'

Example Request Body

{
  "schema_version": 0,
  "cluster_id": "cluster_id",
  "agent_version": "agent_version",
  "agent_instance_id": "agent_instance_id",
  "window_start": "2024-08-25T15:00:00Z",
  "window_end": "2024-08-25T15:00:00Z",
  "unscraped_nodes": {
    "key": 0
  },
  "nodes": [
    {
      "name": "name",
      "provider_id": "provider_id",
      "instance_type": "instance_type",
      "region": "region",
      "zone": "zone",
      "spot": true,
      "observed_seconds": 0,
      "capacity_cpu_cores": 0,
      "capacity_memory_bytes": 0,
      "capacity_gpu": 0,
      "gpu_resources": {
        "key": 0
      },
      "allocatable_cpu_cores": 0,
      "allocatable_memory_bytes": 0,
      "labels": {
        "key": "string"
      },
      "annotations": {
        "key": "string"
      },
      "gpu_labels": {
        "key": "string"
      }
    }
  ],
  "pods": [
    {
      "namespace": "namespace",
      "name": "name",
      "node": "node",
      "controller_kind": "controller_kind",
      "controller": "controller",
      "labels": {
        "key": "string"
      },
      "annotations": {
        "key": "string"
      },
      "namespace_labels": {
        "key": "string"
      },
      "containers": [
        {
          "name": "name",
          "observed_seconds": 0,
          "cpu_request_cores": 0,
          "memory_request_bytes": 0,
          "gpu_request": 0,
          "gpu_requests": {
            "key": 0
          },
          "cpu_usage_core_seconds": 0,
          "memory_usage_byte_seconds": 0,
          "cpu_allocated_core_seconds": 0,
          "memory_allocated_byte_seconds": 0,
          "cpu_usage_peak_cores": 0,
          "memory_usage_peak_bytes": 0
        }
      ],
      "claims": [
        "string"
      ]
    }
  ],
  "volumes": [
    {
      "name": "name",
      "capacity_bytes": 0,
      "storage_class": "storage_class",
      "csi_driver": "csi_driver",
      "volume_handle": "volume_handle",
      "phase": "phase",
      "claim_namespace": "claim_namespace",
      "claim_name": "claim_name",
      "observed_seconds": 0,
      "storage_class_annotations": {
        "key": "string"
      },
      "claim_labels": {
        "key": "string"
      }
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "cluster_id": "cluster_id",
  "status": "status"
}

json

application/json

Folders Providers