Get generic cluster estimated rate information

POST 
/v1/spectroclusters/generic/rate

Get generic cluster estimated rate information

Request

Query Parameters

periodType string

Possible values: [hourly, monthly, yearly]

Default value: hourly

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

cloudConfig

object

Generic cluster config

instanceType

object

diskGiBint32

DiskGiB is the size of a virtual machine's disk, in GiB

memoryMiBint64

MemoryMiB is the size of a virtual machine's memory, in MiB

namestring

numCPUsint32

NumCPUs is the number of virtual processors in a virtual machine

regionstring

cluster region information

machinepoolconfig

undefined[]

Array [

cloudConfig

object

Generic cluster config

instanceType

object

diskGiBint32

DiskGiB is the size of a virtual machine's disk, in GiB

memoryMiBint64

MemoryMiB is the size of a virtual machine's memory, in MiB

namestring

numCPUsint32

NumCPUs is the number of virtual processors in a virtual machine

regionstring

cluster region information

poolConfig

object

Machine pool configuration for the cluster

additionalLabels

object

Additional labels to be part of the machine pool

property name*string

additionalTags

object

AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

property name*string

isControlPlaneboolean

Whether this pool is for control plane

labelsstring[]required

Labels for this machine pool, example: control-plane/worker, gpu, windows

machinePoolProperties

object

Machine pool specific properties

archTypestring

Possible values: [amd64, arm64]

Default value: amd64

Architecture type of the pool. Default value is 'amd64'

maxSizeint32

Max size of the pool, for scaling

minSizeint32

Min size of the pool, for scaling

namestringrequired

nodeRepaveIntervalint32

Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

sizeint32required

Size of the pool, number of nodes/machines

taints

object[]

control plane or worker taints

Array [

effectstring

Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

keystring

The taint key to be applied to a node

timeAddeddate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

valuestring

The taint value corresponding to the taint key.

]

updateStrategy

object

Rolling update strategy for this machine pool if not specified, will use ScaleOut

typestring

Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

useControlPlaneAsWorkerboolean

If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove control plane taint this will not be used for worker pools

]

Responses

200

Genric Cluster estimated rate response

application/json

Schema

Schema

machinePools

object[]

Array [

namestring

nodesCountint32

rate

object

Cloud estimated rate information

compute

object

Compute estimated rate information

ratefloat64

typestring

storage

object[]

Array [

iopsfloat64

ratefloat64

sizeGBfloat64

throughputfloat64

typestring

]

totalfloat64

]

namestring

rate

object

Cluster total estimated rate information

computefloat64

storagefloat64

totalfloat64

resourceMetadata

object

Cloud resource metadata

instanceTypes

object

property name*

object

Cloud Instance type details

categorystring

Category of instance type

cost

object

Instance cost entity

price

object[]

Array of cloud instance price

Array [

onDemanddouble

OnDemand price of instance

osstring

Possible values: [linux, windows]

Os associated with instance price. Allowed values - [linux, windows]

spotdouble

Spot price of instance

]

cpudouble

Cpu of instance type

gpudouble

Gpu of instance type

memorydouble

Memory of instance type

nonSupportedZonesstring[]

Non supported zones of the instance in a particular region

pricedouble

Price of instance type

supportedArchitecturesstring[]

Supported architecture of the instance

typestring

Type of instance type

storageTypes

object

property name*

object

Cloud cloud Storage type details

cost

object

Cloud storage cost

discountedUsagestring

Cloud storage upper limit which is free.

price

object[]

Array of cloud storage range prices

Array [

limitstring

Upper limit of cloud storage usage

pricestring

Price of cloud storage type

]

iopsCost

object

Cloud storage cost

discountedUsagestring

Cloud storage upper limit which is free.

price

object[]

Array of cloud storage range prices

Array [

limitstring

Upper limit of cloud storage usage

pricestring

Price of cloud storage type

]

kindstring

kind of storage type

namestring

Name of the storage type

throughputCost

object

Cloud storage cost

discountedUsagestring

Cloud storage upper limit which is free.

price

object[]

Array of cloud storage range prices

Array [

limitstring

Upper limit of cloud storage usage

pricestring

Price of cloud storage type

]

Example (from schema)

{
  "machinePools": [
    {
      "name": "string",
      "nodesCount": 0,
      "rate": {
        "compute": {
          "rate": 0,
          "type": "string"
        },
        "storage": [
          {
            "iops": 0,
            "rate": 0,
            "sizeGB": 0,
            "throughput": 0,
            "type": "string"
          }
        ],
        "total": 0
      }
    }
  ],
  "name": "string",
  "rate": {
    "compute": 0,
    "storage": 0,
    "total": 0
  },
  "resourceMetadata": {
    "instanceTypes": {},
    "storageTypes": {}
  }
}

Loading...