Skip to content

Compute

Virtual machine instances in your projects, with block storage volumes, public IPv4 addresses and firewalls.

Updated View as Markdown

EZGH Compute runs virtual machine instances in a project. In the console, open Compute. Its sidebar groups everything an instance uses:

Group Pages What they hold
Instances Instances, SSH keys Virtual machines, and the public keys you log in with
Images Images The operating system images instances launch from
Storage Volumes, Snapshots Encrypted block storage, and point-in-time copies of it
Network & security IPv4 addresses, Firewalls Optional public IPv4 addresses, and stateful allow rules

VPCs, subnets and network interfaces are in Private Networks: in the console, open Private Networks.

Every resource belongs to one project in the us-west-1 region, and can only be used with resources in the same project.

Resource IDs

Each resource has an ID with a prefix that names its type, the slug in API responses (id is its UUID). API paths accept either; request bodies take the prefixed ID only.

Resource ID API
Instance ins_… Compute
SSH key ssh_… Compute
Volume vol_… Block Storage
Snapshot snp_… Block Storage
Network interface eni_… Network
IPv4 address pip_… Network
VPC vpc_… Network
Subnet sbn_… Network
Firewall fwl_… Firewall

APIs

API Host
Compute: instances, instance types, SSH keys compute-api.ezghcloud.com
Block Storage: volumes, volume types, snapshots blockstore-api.ezghcloud.com
Network: network interfaces, IPv4 addresses, VPCs and subnets network-api.ezghcloud.com
Firewall: firewalls, rules, attachments firewall-api.ezghcloud.com

Every path is under /v1/organizations/{orgId}, and most under /v1/organizations/{orgId}/projects/{projectId}, with the organization’s and project’s UUIDs. Authentication, paging and errors follow the API conventions.

Operations

Launching, starting, stopping, rebooting, resizing and terminating an instance, attaching and detaching a running instance’s volumes, and creating, modifying and deleting volumes and snapshots, take time. Those requests answer 202 with an operation and a Location header naming it. Poll the operation until its status is succeeded, failed or cancelled; while it’s queued or running, Retry-After says when to poll again. A failed operation’s error has a code and a message.

curl -sS "https://compute-api.ezghcloud.com/v1/organizations/$ORG_ID/operations/$OPERATION_ID" \
  -H "Authorization: Bearer $EZGH_API_KEY"

From the CLI, ezgh compute operations list|get|cancel covers compute’s operations and ezgh compute volumes operations list|get|cancel Block Storage’s, and the commands that start an operation take --wait.

Compute’s operations are at GetOperation on compute-api.ezghcloud.com, Block Storage’s at GetOperation on blockstore-api.ezghcloud.com. Both list the organization’s operations, newest first, and cancel one that’s still cancellable. Assigning, unassigning and moving a secondary private address are Network’s own private address operations. Every other change is synchronous.

Send an Idempotency-Key header with every POST so that a retry gets the first request’s answer instead of acting twice.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close