v1

latestSwagger 2.02026-08-04232286653.5 KB

VMs

Returns details for a single VM in the project.

get/projects/{project_id}/compute/vms/instances/{vm_id}

Path parameters

project_idstring required

ID of the project that owns the VM.

vm_idstring required

ID of the VM.

Response

billing_typestring

Billing type of the VM: On-demand, Spot, or PoC. values: On-demand, Spot, PoC

commitment_endstring

commitment_periodinteger

commitment is no longer supported

created_atstring required

Creation timestamp of the VM, in RFC3339 format.

idstring required

ID of the VM.

instance_group_idstring

ID of the instance group the VM belongs to, if any.

instance_template_idstring

ID of the instance template the VM was created from, if any.

locationstring required

Location the VM runs in.

maintenance_policy'manual' | 'stop-vm' | 'unspecified' required

Host maintenance policy applied to the VM: manual, stop-vm, or unspecified.

namestring required

Name of the VM.

nvlink_domain_idstring

ID of the NVLink domain the VM belongs to, if any.

pod_idstring

ID of the pod the VM belongs to, if any.

project_idstring required

ID of the project that owns the VM.

reservation_idstring

ID of the reservation the VM belongs to, if any.

statestring required

Current lifecycle state of the VM.

typestring required

Product name of the VM type.

updated_atstring required

Last update timestamp of the VM, in RFC3339 format.

Example response

{
  "created_at": "2021-12-03T19:58:34Z",
  "disks": [
    {
      "attachment_type": "os | data",
      "block_size": 4096,
      "created_at": "2021-12-03T19:58:34Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "location": "us-northcentral1-a",
      "mode": "read-write | read-only",
      "name": "my-disk",
      "serial_number": "96FD14FDBCF7E21E8EC",
      "size": "10GiB",
      "type": "persistent-ssd",
      "updated_at": "2021-12-03T19:58:34Z"
    }
  ],
  "host_channel_adapters": [
    {
      "guid": "946d:ae03:0021:69aa",
      "transport_network_id": "ca39e669-47ee-456b-968d-303234fbf99f",
      "transport_partition_id": "ca39e669-47ee-456b-968d-303234fbf99f",
      "type": "infiniband"
    }
  ],
  "id": "ca39e669-47ee-456b-968d-303234fbf99f",
  "instance_group_id": "707749bd-ecad-4de8-aa00-1ae2fdb99e19",
  "instance_template_id": "75c6712a-8da8-463c-a72d-fc65cf922959",
  "location": "us-centralnorth1-a",
  "name": "my-first-vm",
  "network_interfaces": [
    {
      "id": "ca39e669-47ee-456b-968d-303234fbf99f",
      "interface_type": "ethernet",
      "ips": [
        {
          "private_ipv4": {
            "address": "10.1.2.3"
          },
          "public_ipv4": {
            "address": "121.0.0.0",
            "id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
            "type": "dynamic"
          }
        }
      ],
      "mac_address": "00:00:5e:00:53:af",
      "name": "network-interface-1",
      "network": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
      "subnet": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc"
    }
  ],
  "pod_id": "29d20dc4-90ad-4365-ab05-83f5f5e52d94",
  "project_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  "state": "RUNNING",
  "type": "a100.2x",
  "updated_at": "2023-08-14T09:00:35Z",
  "virtualization_features": {
    "nested_virtualization": true
  }
}