Update Mc

PATCH 
/v1/armada/machine_class/:mc_id

Update a machine class

Request

Path Parameters

mc_id uuidrequired

The machine class ID

application/json

Body

required

datacenter_provider

object

name Name (string)required

Possible values: non-empty and <= 64 characters

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

datacenter_provider_id uuidrequired
name Name (string)

Possible values: non-empty and <= 64 characters

type Type (string)

Possible values: non-empty and <= 64 characters

labels string[]

Possible values: non-empty and <= 64 characters

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

monthly_price Monthly Price (number)

The monthly price of this machine class

hourly_price Hourly Price (number)

The hourly price of this machine class

cpu_count Cpu Count (integer)

The number of CPUs

cpu_info Cpu Info (string)

Possible values: non-empty

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

cpu_type Cpu Type (string)

Possible values: non-empty and <= 64 characters

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

cpu_sockets Cpu Sockets (integer)

The number of populated CPU sockets

cpu_cores Cpu Cores (integer)

The number of CPU cores

cpu_threads Cpu Threads (integer)

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

memory_size_gigabytes Memory Size Gigabytes (integer)

The amount of memory in gigabytes

memory_type Memory Type (string)

Possible values: non-empty and <= 32 characters

The type of memory. e.g. DDR4

memory_speed_rating Memory Speed Rating (integer)

The speed rating of the memory in MHz

memory_timings Memory Timings (string)

Possible values: non-empty and <= 32 characters

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

disk_type Disk Type (string)

Possible values: non-empty and <= 64 characters

The type of disk. e.g. SSD

disk_size_gigabytes Disk Size Gigabytes (integer)

The size of the disk in gigabytes

disk_sequential_read Disk Sequential Read (string)

Possible values: non-empty and <= 64 characters

The sequential read speed of the disk

disk_sequential_write Disk Sequential Write (string)

Possible values: non-empty and <= 64 characters

The sequential write speed of the disk

disk_random_read Disk Random Read (string)

Possible values: non-empty and <= 64 characters

The random read speed of the disk

disk_random_write Disk Random Write (string)

Possible values: non-empty and <= 64 characters

The random write speed of the disk

disk_iops Disk Iops (integer)

The number of IOPS the disk can handle

disk_latency_ms Disk Latency Ms (integer)

The latency of the disk in milliseconds

network_gbps Network Gbps (integer)

The network speed in gigabits per second

gpu_type Gpu Type (string)

Possible values: non-empty and <= 64 characters

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

gpu_count Gpu Count (integer)

The number of GPUs

gpu_memory_gigabytes Gpu Memory Gigabytes (integer)

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

datacenter_provider_id uuid

Responses

200

Successful Response

application/json

Schema

Schema

datacenter_provider

object

required

name Name (string)required

Possible values: non-empty and <= 64 characters

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

datacenter_provider_id uuidrequired
name Name (string)required

Possible values: non-empty and <= 64 characters

The name of the machine class used by the provider

type Type (string)required

Possible values: non-empty and <= 64 characters

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

labels string[]

Possible values: non-empty and <= 64 characters

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

monthly_price Monthly Price (number)

The monthly price of this machine class

hourly_price Hourly Price (number)

The hourly price of this machine class

cpu_count Cpu Count (integer)

The number of CPUs

cpu_info Cpu Info (string)

Possible values: non-empty

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

cpu_type Cpu Type (string)

Possible values: non-empty and <= 64 characters

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

cpu_sockets Cpu Sockets (integer)

The number of populated CPU sockets

cpu_cores Cpu Cores (integer)

The number of CPU cores

cpu_threads Cpu Threads (integer)

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

memory_size_gigabytes Memory Size Gigabytes (integer)

The amount of memory in gigabytes

memory_type Memory Type (string)

Possible values: non-empty and <= 32 characters

The type of memory. e.g. DDR4

memory_speed_rating Memory Speed Rating (integer)

The speed rating of the memory in MHz

memory_timings Memory Timings (string)

Possible values: non-empty and <= 32 characters

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

disk_type Disk Type (string)

Possible values: non-empty and <= 64 characters

The type of disk. e.g. SSD

disk_size_gigabytes Disk Size Gigabytes (integer)

The size of the disk in gigabytes

disk_sequential_read Disk Sequential Read (string)

Possible values: non-empty and <= 64 characters

The sequential read speed of the disk

disk_sequential_write Disk Sequential Write (string)

Possible values: non-empty and <= 64 characters

The sequential write speed of the disk

disk_random_read Disk Random Read (string)

Possible values: non-empty and <= 64 characters

The random read speed of the disk

disk_random_write Disk Random Write (string)

Possible values: non-empty and <= 64 characters

The random write speed of the disk

disk_iops Disk Iops (integer)

The number of IOPS the disk can handle

disk_latency_ms Disk Latency Ms (integer)

The latency of the disk in milliseconds

network_gbps Network Gbps (integer)

The network speed in gigabits per second

gpu_type Gpu Type (string)

Possible values: non-empty and <= 64 characters

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

gpu_count Gpu Count (integer)

The number of GPUs

gpu_memory_gigabytes Gpu Memory Gigabytes (integer)

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

machine_class_id uuidrequired

Example (from schema)

{
  "datacenter_provider": {
    "name": "string",
    "datacenter_provider_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "name": "string",
  "type": "string",
  "labels": [
    "string"
  ],
  "monthly_price": 0,
  "hourly_price": 0,
  "cpu_count": 0,
  "cpu_info": "string",
  "cpu_type": "string",
  "cpu_sockets": 0,
  "cpu_cores": 0,
  "cpu_threads": 0,
  "memory_size_gigabytes": 0,
  "memory_type": "string",
  "memory_speed_rating": 0,
  "memory_timings": "string",
  "disk_type": "string",
  "disk_size_gigabytes": 0,
  "disk_sequential_read": "string",
  "disk_sequential_write": "string",
  "disk_random_read": "string",
  "disk_random_write": "string",
  "disk_iops": 0,
  "disk_latency_ms": 0,
  "network_gbps": 0,
  "gpu_type": "string",
  "gpu_count": 0,
  "gpu_memory_gigabytes": 0,
  "machine_class_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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...