Cloud Cost API
The Cloud Cost API provides multiple endpoints to obtain accurate cost information from your cloud service providers (CSPs), including data available from cloud billing reports (such as AWS' Cost and Usage Report (CUR)).
Cloud Cost querying API
GET
http://<your-kubecost-address>/model/cloudCost
Samples full granularity of cloud costs from cloud billing report (ex. AWS' Cost and Usage Report)
Path Parameters
Name | Type | Description |
---|---|---|
window* | String | Duration of time over which to query. Accepts multiple different formats of time (see this Using the |
aggregate | String | Field by which to aggregate the results. Accepts: |
accumulate | boolean | When set to |
offset | int | Refers to the number of line items you are offsetting. Pairs with |
limit | int | Refers to the number of line items per page. Pair with the |
filter | string | Filter your results by any category which you can aggregate by, can support multiple filterable items in the same category in a comma-separated list. For example, to filter results by providers A and B, use |
Schema overview
Cloud cost metrics
Cloud cost metric types values are based on and calculated following standard FinOps dimensions and metrics. The five types of cloud cost metrics provided by the Cloud Cost API are:
Cost Metric | Description |
---|---|
Amortized Net Cost |
|
Net Cost | Costs inclusive of discounts and credits. Will also include one-time and recurring charges. |
List Cost | CSP pricing without any discounts |
Invoiced Cost | Pricing based on usage during billing period |
Amortized Cost | Effective/upfront cost across the billing period |
See our Cloud Cost Metrics doc to learn more about these cost metric types and how they are calculated.
kubernetesPercent
kubernetesPercent
Each cost metric also has a kubernetesPercent
value. Unaggregated, this value will be 0 or 1. When you aggregate, kubernetesPercent
is determined by multiplying the cost metric cost by its kubernetesPercent
and aggregating that value as kubernetesCost
for that cost metric. That kubernetesCost
is then divided by the aggregated total costs to determine the new kubernetesPercent
. Since this process results in unique values for each cost metric, this value is included as part of the cost metric.
Examples
Query for cloud net costs within the past two days, aggregated by accounts, filtered only for Amazon EC2 costs
Last updated