Skip to main content
GET
Get instance details

Authorizations

Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

region
string
required

Region identifier

project
string
required

Project identifier

id
string
required

Unique instance identifier

Response

Instance details

Compute instance (VM or baremetal).

Server-defined URL for this resource.

Example:

"/v1/regions/us-texas-1/projects/project-x9y8z7/compute/instances/instance-d4e5f6"

uid
string<uuid>
read-only

Server-generated UUID.

id
string

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z [blocked]? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"instance-d4e5f6"

displayName
string

Optional human-friendly display name for the instance.

description
string

An optional description of this resource.

labels
object

Labels to apply to this resource.

type
string<uri>

URI of the instance type resource to use for this instance. Immutable after creation.

(TODO): support for custom types similar to GCP or user-defined types via project-based machineType like /v1/regions/us-texas-1/projects/project-x9y8z7/compute/instance-types/user-type-1.

Example:

"/v1/regions/us-texas-1/zones/us1-a/instance-types/g1-xlarge"

instanceMetadata
object[]

Instance metadata assigned to this instance, exposed via metadata service. Including, but not limited to, SSH keys and cloud-init metadata.

hostname
string

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If not specified, the default hostname will be generated.

(TBD): hostname template similar to [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal; may change based on CSP configuration.

lifecycle
object
disks
object[]
nics
object[]
gpus
object[]

(TBD): this is a specialized version of GCP instance.guestAccelerators. Using list & count at the same time leaves this API open for extension, e.g.:

  • if physical hosts have different GPUs attached (is it likely?)
  • if we need advanced topology support (NUMA-awareness)
createdAt
string<date-time>
updatedAt
string<date-time>