REST Resource: projects.locations.instances

Resource: Instance

A server.

JSON representation 
{
  "name": string,
  "id": string,
  "createTime": string,
  "updateTime": string,
  "machineType": string,
  "state": enum (State),
  "hyperthreadingEnabled": boolean,
  "labels": {
    string: string,
    ...
  },
  "luns": [
    {
      object (Lun)
    }
  ],
  "volumes": [
    {
      object (Volume)
    }
  ],
  "networks": [
    {
      object (Network)
    }
  ],
  "interactiveSerialConsoleEnabled": boolean,
  "osImage": string,
  "pod": string,
  "networkTemplate": string,
  "logicalInterfaces": [
    {
      object (LogicalInterface)
    }
  ],
  "loginInfo": string,
  "workloadProfile": enum (WorkloadProfile),
  "firmwareVersion": string
}
Fields
name

string

Immutable. 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}
id

string

Output only. An identifier for the Instance, generated by the backend.
createTime

string (Timestamp format)

Output only. Create a time stamp.
updateTime

string (Timestamp format)

Output only. Update a time stamp.
machineType

string

Immutable. The server type. Available server types
state

enum (State)

Output only. 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)

Immutable. List of LUNs associated with this server.
volumes[]

object (Volume)

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
networks[]

object (Network)

Output only. List of networks associated with this server.
interactiveSerialConsoleEnabled

boolean

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

string

The OS image currently installed on the server.
pod

string

Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
networkTemplate

string

Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
logicalInterfaces[]

object (LogicalInterface)

List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
loginInfo

string

Output only. Text field about info for logging in.
workloadProfile

enum (WorkloadProfile)

The workload profile for the instance.
firmwareVersion

string

Output only. The firmware version for the instance.

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.
UPDATING The server is being updated.
STARTING The server is starting.
STOPPING The server is stopping.
SHUTDOWN The server is shutdown.

LogicalInterface

Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.

JSON representation 
{
  "logicalNetworkInterfaces": [
    {
      object (LogicalNetworkInterface)
    }
  ],
  "name": string,
  "interfaceIndex": integer
}
Fields
logicalNetworkInterfaces[]

object (LogicalNetworkInterface)

List of logical network interfaces within a logical interface.
name

string

Interface name. This is of syntax or and forms part of the network template name.
interfaceIndex
(deprecated)

integer

The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.

LogicalNetworkInterface

Each logical network interface is effectively a network and IP pair.

JSON representation 
{
  "network": string,
  "ipAddress": string,
  "defaultGateway": boolean,
  "networkType": enum (Type),
  "id": string
}
Fields
network

string

Name of the network
ipAddress

string

IP address in the network
defaultGateway

boolean

Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
networkType

enum (Type)

Type of network.
id

string

An identifier for the Network, generated by the backend.

WorkloadProfile

The possible values for a workload profile.

Enums
WORKLOAD_PROFILE_UNSPECIFIED The workload profile is in an unknown state.
WORKLOAD_PROFILE_GENERIC The workload profile is generic.
WORKLOAD_PROFILE_HANA The workload profile is hana.

Methods

create

 Create an Instance.

detachLun

 Detach LUN from Instance.

get

 Get details about a single server.

list

 List servers in a given project and location.

patch

 Update details of a single server.

rename

 RenameInstance sets a new name for an instance.

reset

 Perform an ungraceful, hard reset on a server.

start

 Starts a server that was shutdown.

stop

 Stop a running server.