Gets cluster workload efficiency report for a workload by name.

get

https://api.cast.ai/v1/cost-reports/clusters/{clusterId}/namespaces/{namespace}/{workloadType}/{workloadName}/efficiency

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clusterId

string

required

ID of the cluster.

namespace

string

required

Namespace of the workload.

workloadType

string

required

Workload type, e.g. Deployment, StatefulSet, DaemonSet.

workloadName

string

required

Name of the workload.

Query Params

startTime

date-time

required

Filter items to include from specified time.

endTime

date-time

required

Filter items to include up to specified time.

stepSeconds

int32

Aggregate items in specified interval steps.

includeCurrent

boolean

Optional parameter marking whether the current state for workload and its containers should be returned.

includeHistory

boolean

Defaults to true

Optional parameter marking whether the history of workload and its containers should be returned.

useListingPrices

boolean

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

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.