Get a virtual machine

Retrieves the details of a virtual machine.

GET /v1/projects/{projectId}/vms/{id}

Get a virtual machine

cURL

curl --request GET \
  --url https://rest.compute.cudo.org/v1/projects/{projectId}/vms/{id} \
  --header 'Authorization: <api-key>'

200

{
  "VM": {
    "commitmentTerm": "COMMITMENT_TERM_NONE",
    "projectId": "<string>",
    "authorizedSshKeys": "<string>",
    "bootDisk": {
      "dataCenterId": "<string>",
      "id": "<string>",
      "projectId": "<string>",
      "sizeGib": 123,
      "createTime": "2023-11-07T05:31:56Z",
      "diskState": "UNKNOWN",
      "diskType": "DISK_TYPE_UNKNOWN",
      "privateImageId": "<string>",
      "publicImageId": "<string>",
      "vmId": "<string>"
    },
    "bootDiskSizeGib": 123,
    "commitmentEndTime": "2023-11-07T05:31:56Z",
    "cpuModel": "<string>",
    "createBy": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "datacenterId": "<string>",
    "expireTime": "2023-11-07T05:31:56Z",
    "externalIpAddress": "<string>",
    "gpuModel": "<string>",
    "gpuModelId": "<string>",
    "gpuQuantity": 123,
    "id": "<string>",
    "imageId": "<string>",
    "imageName": "<string>",
    "internalIpAddress": "<string>",
    "machineType": "<string>",
    "memory": 123,
    "metadata": {},
    "nics": [
      {
        "externalIpAddress": "<string>",
        "internalIpAddress": "<string>",
        "networkAddress": "<string>",
        "networkId": "<string>",
        "securityGroupIds": [
          "<string>"
        ]
      }
    ],
    "price": {
      "gpuPriceHr": {
        "value": "<string>"
      },
      "ipv4AddressPriceHr": {
        "value": "<string>"
      },
      "memoryGibPriceHr": {
        "value": "<string>"
      },
      "storageGibPriceHr": {
        "value": "<string>"
      },
      "totalGpuPriceHr": {
        "value": "<string>"
      },
      "totalMemoryPriceHr": {
        "value": "<string>"
      },
      "totalPriceHr": {
        "value": "<string>"
      },
      "totalStoragePriceHr": {
        "value": "<string>"
      },
      "totalVcpuPriceHr": {
        "value": "<string>"
      },
      "vcpuPriceHr": {
        "value": "<string>"
      }
    },
    "privateImageId": "<string>",
    "publicImageId": "<string>",
    "publicImageName": "<string>",
    "publicIpAddress": "<string>",
    "renewableEnergy": true,
    "rules": [
      {
        "icmpType": "<string>",
        "id": "<string>",
        "ipRangeCidr": "<string>",
        "ports": "<string>",
        "protocol": "PROTOCOL_UNKNOWN",
        "ruleType": "RULE_TYPE_UNKNOWN"
      }
    ],
    "securityGroupIds": [
      "<string>"
    ],
    "securityGroups": [
      {
        "dataCenterId": "<string>",
        "id": "<string>",
        "description": "<string>",
        "projectId": "<string>",
        "rules": [
          {
            "icmpType": "<string>",
            "id": "<string>",
            "ipRangeCidr": "<string>",
            "ports": "<string>",
            "protocol": "PROTOCOL_UNKNOWN",
            "ruleType": "RULE_TYPE_UNKNOWN"
          }
        ]
      }
    ],
    "shortState": "<string>",
    "sshKeySource": "SSH_KEY_SOURCE_UNKNOWN",
    "state": "CLONING",
    "storageDisks": [
      {
        "dataCenterId": "<string>",
        "id": "<string>",
        "projectId": "<string>",
        "sizeGib": 123,
        "createTime": "2023-11-07T05:31:56Z",
        "diskState": "UNKNOWN",
        "diskType": "DISK_TYPE_UNKNOWN",
        "privateImageId": "<string>",
        "publicImageId": "<string>",
        "vmId": "<string>"
      }
    ],
    "vcpus": 123
  },
  "gpuPriceHr": {
    "value": "<string>"
  },
  "ipv4PriceHr": {
    "value": "<string>"
  },
  "memoryGibPriceHr": {
    "value": "<string>"
  },
  "storageGibPriceHr": {
    "value": "<string>"
  },
  "totalGpuPriceHr": {
    "value": "<string>"
  },
  "totalMemoryPriceHr": {
    "value": "<string>"
  },
  "totalPriceHr": {
    "value": "<string>"
  },
  "totalStoragePriceHr": {
    "value": "<string>"
  },
  "totalVcpuPriceHr": {
    "value": "<string>"
  },
  "vcpuPriceHr": {
    "value": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API key authentication. API keys should be passed using the format Bearer API_KEY.

Path Parameters

projectId · string · required

id · string · required

Response

200

application/json

A successful response.

VM · object · required

Show child attributes

gpuPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

ipv4PriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

memoryGibPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

storageGibPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

totalGpuPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

totalMemoryPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

totalPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

totalStoragePriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

totalVcpuPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

vcpuPriceHr · object · required

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes