Get Cost Breakdown for Multiple Clusters

GET 
/dashboard/:cluster_type/cost-breakdown

Retrieve detailed cost breakdowns for one or more specified clusters of a given type within a defined date range.

Request

Path Parameters

cluster_type anyrequired

Type of the cluster (eks, asg)

Query Parameters

cluster_id integer[]

List of cluster IDs for which to retrieve the cost breakdown.

date_start Date Start

Default value: 2024-09-25

Start date for the cost report (format: YYYY-MM-DD). Defaults to 30 days ago.

date_end Date End

Default value: 2024-10-25

End date for the cost report (format: YYYY-MM-DD). Defaults to today.

Header Parameters

X-Nops-Api-Key stringrequired

API key for authentication

Responses

200

Successfully retrieved the cost breakdown for the specified clusters.

application/json

Schema

Schema

• Array [

cluster_id integerrequired

The ID of the cluster.

cpu numberrequired

Total cost associated with CPU usage.

gpu numberrequired

Total cost associated with GPU usage.

memory numberrequired

Total cost associated with memory usage.

storage numberrequired

Total cost associated with storage.

network numberrequired

Total cost associated with network usage.

control_plane numberrequired

Total cost associated with control plane resources.

extended_support numberrequired

Total cost associated with extended support options.

• ]

Example (from schema)

[
  {
    "cluster_id": 0,
    "cpu": 0,
    "gpu": 0,
    "memory": 0,
    "storage": 0,
    "network": 0,
    "control_plane": 0,
    "extended_support": 0
  }
]

400

Cost Breakdown is not available for Autoscaling Groups.

404

No clusters found or invalid cluster IDs.

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...