Skip to content

Get Mc

GET
/v1/armada/machine_class/{mc_id}

Get a machine class

Authorizations

Parameters

Path Parameters

mc_id
required

The machine class ID

string format: uuid

The machine class ID

Responses

200

Successful Response

A description of a type of performance characteristics either real or virtual. At DigitalOcean and Azure this is called VM Size. At AWS this is called Instance type. At Google this is called machine type or machine configuration.

object
datacenter_provider
required

The provider this machine class is associated with

object
name
required

Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.

string
>= 1 characters <= 64 characters
datacenter_provider_id
required
string format: uuid
name
required

The name of the machine class used by the provider

string
>= 1 characters <= 64 characters
type
required

The type of machine class used by the provider. General Purpose, CPU Optimized, etc.

string
>= 1 characters <= 64 characters
labels

Labels that can be applied to the machine class for organizational purposes

Array<string>
monthly_price

The monthly price of this machine class

number
hourly_price

The hourly price of this machine class

number
cpu_count

The number of CPUs

integer
cpu_info

A description of the CPU including type, family, model, and stepping

string
>= 1 characters
cpu_type

The short description of the CPU type. e.g. Intel Xeon E5-2673 v4 @ 2.30GHz

string
>= 1 characters <= 64 characters
cpu_sockets

The number of populated CPU sockets

integer
cpu_cores

The number of CPU cores

integer
cpu_threads

The number of CPU threads. Will be more than cores if hyperthreading is enabled.

integer
memory_size_gigabytes

The amount of memory in gigabytes

integer
memory_type

The type of memory. e.g. DDR4

string
>= 1 characters <= 32 characters
memory_speed_rating

The speed rating of the memory in MHz

integer
memory_timings

The memory timings. e.g. 15-15-15-36

string
>= 1 characters <= 32 characters
disk_type

The type of disk. e.g. SSD

string
>= 1 characters <= 64 characters
disk_size_gigabytes

The size of the disk in gigabytes

integer
disk_sequential_read

The sequential read speed of the disk

string
>= 1 characters <= 64 characters
disk_sequential_write

The sequential write speed of the disk

string
>= 1 characters <= 64 characters
disk_random_read

The random read speed of the disk

string
>= 1 characters <= 64 characters
disk_random_write

The random write speed of the disk

string
>= 1 characters <= 64 characters
disk_iops

The number of IOPS the disk can handle

integer
disk_latency_ms

The latency of the disk in milliseconds

integer
network_gbps

The network speed in gigabits per second

integer
gpu_type

The type of GPU. e.g. NVIDIA Tesla V100

string
>= 1 characters <= 64 characters
gpu_count

The number of GPUs

integer
gpu_memory_gigabytes

The amount of GPU memory in gigabytes. Should be the lowest available memory if there are multiple GPUs.

integer
machine_class_id
required
string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string