Get Instances in a Cluster
GET/dashboard/:cluster_type/instances/:cluster_id
Get Instances in a Cluster
Request
Path Parameters
cluster_id Cluster Idrequired
cluster_type anyrequired
Type of the cluster (eks, asg)
Query Parameters
instance_type string[]
Optional list of Instance Types to filter
availability_zone string[]
Optional list of Availability Zones to filter
date_start Date Start
Default value: 2024-09-25
Start date for effective savings period (YYYY-MM-DD)
date_end Date End
Default value: 2024-10-25
End date for effective savings period (YYYY-MM-DD)
Header Parameters
X-Nops-Api-Key stringrequired
API key for authentication
Responses
- 200
- 422
Successful response with list of instances.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
instance_id Instance Id (string)required
node_name Node Name (string)required
node_pool_name Node Pool Name (string)required
launched_by Launched By (string)required
Possible values: [nops
, aws
]
instance_type Instance Type (string)required
pricing_model Pricing Model (string)required
Possible values: [spot
, on-demand
]
availability_zone Availability Zone (string)required
state State (string)required
launch_time date-timerequired
runtime_duration Runtime Duration (string)required
runtime_duration_minutes Runtime Duration Minutes (number)required
effective_savings_rate Effective Savings Rate (number)required
[
{
"instance_id": "string",
"node_name": "string",
"node_pool_name": "string",
"launched_by": "nops",
"instance_type": "string",
"pricing_model": "spot",
"availability_zone": "string",
"state": "string",
"launch_time": "2024-07-29T15:51:28.071Z",
"runtime_duration": "string",
"runtime_duration_minutes": 0,
"effective_savings_rate": 0
}
]
[
{
"instance_id": "i-09b4124aec331c9a1",
"node_name": "ip-10-8-55-40.us-west-2.compute.internal",
"node_pool_name": "nops-prod-default",
"launched_by": "nOps",
"instance_type": "m6a.large",
"pricing_model": "spot",
"availability_zone": "us-west-2c",
"state": "running",
"launch_time": "2024-10-16 17:26:04",
"runtime_duration": "8days 18h 46m",
"runtime_duration_minutes": 12646.944998316667,
"effective_savings_rate": 9.243197678500003
},
{
"instance_id": "i-022205e602116f6f7",
"node_name": "ip-10-8-23-201.us-west-2.compute.internal",
"node_pool_name": "nops-prod-default",
"launched_by": "nOps",
"instance_type": "m5zn.6xlarge",
"pricing_model": "on-demand",
"availability_zone": "us-west-2b",
"state": "running",
"launch_time": "2024-10-02 18:33:02",
"runtime_duration": "22days 17h 39m",
"runtime_duration_minutes": 32739.978332366667,
"effective_savings_rate": 0
}
]
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...