UMumbrellacost
Kubernetes

Get Kubernetes cost

The call is used to retrieve kubernetes data grouped and filtered by different values

get/api/v1/kubernetes/cost-and-usage

Request

  • Base URL
    https://api.umbrellacost.io
  • URL
    https://api.umbrellacost.io/api/v1/kubernetes/cost-and-usage
  • Auth
    none declared. Required headers: Authorization, apikey

Query parameters

groupBystring required

The group by value that will be used for the results. Possible values: Available values : cluster, region, linkedaccname, linkedaccid, namespace, node, instancetype, labels, customtags

startDatestring date required

Start date of the cost and usage data examination

endDatestring date required

End date of the cost and usage data examination

periodGranLevel string required

Granularity level of the period in the output data. Available values : month, week, day

costUsageTypestring required

Available valuye: Available values : compute, dataTransfer, storage

usageTypestring

Available values : CPU, Memory

metricTypestring

Available values : actual, requirements

isNetUnblendedboolean

Available values : true, false

isAmortizedstring

Available values : true, false

isNetAmortizedstring

Available values : true, false

wheresstring

conditions of type if x equals y when retrieving data. Available values : cluster, region, linkedaccname, linkedaccid, namespace, node, instancetype, labels, customtags

filtersstring

conditions of type if x in (y,z,w) when retrieving data. Available values : cluster, region, linkedaccname, linkedaccid, namespace, node, instancetype, labels, customtags

excludeFiltersstring

conditions of type if x not in (y,z,w) when retrieving data. Available values : cluster, region, linkedaccname, linkedaccid, namespace, node, instancetype, labels, customtags

Headers

Authorizationstring required
apikeystring required

Response

dataobject
groupBystring
usageDatestring
accountIdstring
clusterNamestring
totalCostinteger
totalUsagestring
nextPagestring

Changes

No recorded changes to this operation across all 1 revision of this API.