API Reference

Gets cluster workloads compute cost report.

post
https://api.cast.ai/v1/cost-reports/clusters//workload-cost-summaries
Path Params
string
required

ID of the cluster.

Query Params
date-time
required

Filter items to include from specified time.

date-time
required

Filter items to include up to specified time.

string
string

Cursor that defines token indicating where to start the next page. Empty value indicates to start from beginning of the dataset.

string

Name of the field you want to sort

string
enum
Defaults to ASC

The sort order, possible values ASC or DESC, if not provided asc is the default

  • ASC: ASC
  • asc: desc
  • DESC: ASC
  • desc: desc
Allowed:
labelsToInclude
array of strings

Labels to be included for each workload.

labelsToInclude
boolean

Whether to use listing prices instead of actual prices for cost calculations.

boolean

Whether the costs should include costs of the unallocated nodes resources, fairly distributed to workloads based on requested workload resources.

Body Params

Workload filtering options.

labels
array of objects
labels
workloadNames
array of strings
workloadNames
string
enum
Defaults to OR
Allowed:
workloadTypes
array of strings
workloadTypes
namespaces
array of strings
namespaces
Response

Updated 7 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago