REST Resource: projects.locations.instances

Stay organized with collections Save and categorize content based on your preferences.

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)
    }
  ],
  "networks": [
    {
      object (Network)
    }
  ],
  "interactiveSerialConsoleEnabled": boolean,
  "osImage": string
}
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}

id

string

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

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.

osImage

string

The OS image currently installed on the server.

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.

Methods

get

Get details about a single server.

list

List servers in a given project and location.

patch

Update details of a single server.

reset

Perform an ungraceful, hard reset on a server.

start

Starts a server that was shutdown.

stop

Stop a running server.