Returns the estimated cost of the supplied node pool

POST 
/api/v2/costestimates/:provider/nodepool

Returns the estimated cost of the supplied node pool

Request

Path Parameters

provider stringrequired

Kubernetes provider to estimate node pool for

Query Parameters

region string

Optional region to use when estimating node pool

application/json

Body

required

The specification for the node pool you want estimating

autoscaling

Autoscaling indicates the node pool should auto-scale

enabled boolean

Enabled indicates the node pool to use autoscaling

maxSize int64

MaxSize is the maximum number of nodes if autoscaling is enabled

minSize int64

MinSize is minimum number of nodes if autoscaling is enabled

cloudResourceName string

CloudResourceName is the name of the node pool in the cloud provider. If unpopulated, a sensible default name will be auto-generated for this node pool.

diskSize int64required

DiskSize is the amount of disk space to assign to the nodes in MBs

image stringrequired

Image is the image we should use on the instances of this pool

labels

object

Labels to be placed onto the node pool nodes to enable workloads to target this node pool selectively

property name* string
logicalName stringrequired

LogicalName is the internally unique name of the NodePool (not in cloud) - Should always be consistent with a single name entry in a Cluster or NodePoolUpdate - Has to be unique across all node pools on the Cluster spec - Will NOT always match the name of the NodePool in cloud - Should be treated as an immutable field

machine stringrequired

Machine is the instance type of the nodes in the pool

maxPodsPerNode int64

MaxPodsPerNode controls how many pods can be scheduled onto each node in this pool

providerDetails

ProviderDetails provides any cloud specific options for this node pool

aks

AKS defines the cloud specific options for AKS clusters

mode string

Mode is the type of the node pool. System node pools serve the primary purpose of hosting critical system pods such as CoreDNS and tunnelfront. User node pools serve the primary purpose of hosting your application pods.

size int64required

Size is initial size if autoscaling defined - or the effective size if no autoscaling is enabled

spot

Spot, if defined, enables the node pool to use spot instances

aks

AKS defines the options for AKS spot instances

maxSpotPrice string

MaxSpotPrice is the maximum price willing to pay for an spot instance billed in microdollars. The figure is optional and needless to say only relevant when the nodepool is made of spot instances

eks

EKS provides additional options for EKS

additionalInstanceTypes string[]

AdditionalInstanceTypes provides an additional list of instances to use when spot instances is enabled

enabled boolean

Enabled indicates the node pool should use spots

taints

undefined[]

Taints defines a collection scheduling taints placed on the node pool

Array [

effect string

Effect is desired action on the taint

key string

Key is a unique taint identifier

value string

Value is the value that must be matched for the taint to apply

]

zones string[]

Zones defines a list of cloud specific availability zones where the nodes are permitted to run

Responses

200

An estimate of the costs for the node pool

application/json

Schema

Schema

costElements

undefined[]

Array [

maxCost int64required

minCost int64required

name string

typicalCost int64required

]

maxCost int64required
minCost int64required
preparedAt string
typicalCost int64required

Example (from schema)

{
  "costElements": [
    {
      "maxCost": 0,
      "minCost": 0,
      "name": "string",
      "typicalCost": 0
    }
  ],
  "maxCost": 0,
  "minCost": 0,
  "preparedAt": "string",
  "typicalCost": 0
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32required

fieldErrors

undefined[]

required

Array [

errCode stringrequired

field stringrequired

message stringrequired

]

message stringrequired

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...