REST Resource: projects.locations.instances

Resource: Instance

A server.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "machineType": string,
  "state": enum (State),
  "hyperthreadingEnabled": boolean,
  "labels": {
    string: string,
    ...
  },
  "luns": [
    {
      object (Lun)
    }
  ],
  "networks": [
    {
      object (Network)
    }
  ],
  "interactiveSerialConsoleEnabled": boolean
}
Fields
name

string

Output only. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

createTime

string (Timestamp format)

Output only. Create a time stamp.

updateTime

string (Timestamp format)

Output only. Update a time stamp.

machineType

string

The server type. Available server types

state

enum (State)

The state of the server.

hyperthreadingEnabled

boolean

True if you enable hyperthreading for the server, otherwise false. The default value is false.

labels

map (key: string, value: string)

Labels as key value pairs.

luns[]

object (Lun)

List of LUNs associated with this server.

networks[]

object (Network)

List of networks associated with this server.

interactiveSerialConsoleEnabled

boolean

True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.

State

The possible states for this server.

Enums
STATE_UNSPECIFIED The server is in an unknown state.
PROVISIONING The server is being provisioned.
RUNNING The server is running.
DELETED The server has been deleted.

Lun

A storage volume logical unit number (LUN).

JSON representation
{
  "name": string,
  "state": enum (State),
  "sizeGb": string,
  "multiprotocolType": enum (MultiprotocolType),
  "storageVolume": string,
  "shareable": boolean,
  "bootLun": boolean,
  "storageType": enum (StorageType)
}
Fields
name

string

Output only. The name of the LUN.

state

enum (State)

The state of this storage volume.

sizeGb

string (int64 format)

The size of this LUN, in gigabytes.

multiprotocolType

enum (MultiprotocolType)

The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.

storageVolume

string

Display the storage volume for this LUN.

shareable

boolean

Display if this LUN can be shared between multiple physical servers.

bootLun

boolean

Display if this LUN is a boot LUN.

storageType

enum (StorageType)

The storage type for this LUN.

State

The possible states for the LUN.

Enums
STATE_UNSPECIFIED The LUN is in an unknown state.
CREATING The LUN is being created.
UPDATING The LUN is being updated.
READY The LUN is ready for use.
DELETING The LUN has been requested to be deleted.

MultiprotocolType

Display the operating systems present for the LUN multiprotocol type.

Enums
MULTIPROTOCOL_TYPE_UNSPECIFIED Server has no OS specified.
LINUX Server with Linux OS.

StorageType

The storage types for a LUN.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this LUN is unknown.
SSD This storage type for this LUN is SSD.
HDD This storage type for this LUN is HDD.

Network

A network.

JSON representation
{
  "name": string,
  "network": string,
  "type": enum (Type),
  "ipAddress": string,
  "macAddress": [
    string
  ]
}
Fields
name

string

Output only. The resource name of this Network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/networks/{network} This field will contain the same value as field "network", which will soon be deprecated. Please use this field to reference the name of the network resource.

network

string

Name of the network.

type

enum (Type)

The type of this network.

ipAddress

string

IP address configured.

macAddress[]

string

List of physical interfaces.

Type

Network type.

Enums
TYPE_UNSPECIFIED Unspecified value.
CLIENT Client network, a network peered to a Google Cloud VPC.
PRIVATE Private network, a network local to the Bare Metal Solution environment.

Methods

get

Get details about a single server.

list

List servers in a given project and location.