Instances

Represents an Instance resource. See the Instance documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

An Instance resource.

{
  "kind": "compute#instance",
  "id": unsigned long,
  "creationTimestamp": string,
  "zone": string,
  "status": string,
  "statusMessage": string,
  "name": string,
  "description": string,
  "tags": {
    "items": [
      string
    ],
    "fingerprint": bytes
  },
  "machineType": string,
  "canIpForward": boolean,
  "networkInterfaces": [
    {
      "network": string,
      "networkIP": string,
      "name": string,
      "accessConfigs": [
        {
          "kind": "compute#accessConfig",
          "type": string,
          "name": string,
          "natIP": string
        }
      ]
    }
  ],
  "disks": [
    {
      "kind": "compute#attachedDisk",
      "index": integer,
      "type": string,
      "mode": string,
      "source": string,
      "deviceName": string,
      "boot": boolean,
      "initializeParams": {
        "diskName": string,
        "sourceImage": string,
        "diskSizeGb": long,
        "diskStorageType": string,
        "diskType": string
      },
      "autoDelete": boolean,
      "licenses": [
        string
      ],
      "interface": string
    }
  ],
  "metadata": {
    "kind": "compute#metadata",
    "fingerprint": bytes,
    "items": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "serviceAccounts": [
    {
      "email": string,
      "scopes": [
        string
      ]
    }
  ],
  "selfLink": string,
  "scheduling": {
    "onHostMaintenance": string,
    "automaticRestart": boolean
  },
  "cpuPlatform": string
}

Methods

The following are valid Instance resource methods:

addAccessConfig

Adds an access config to an instance's network interface.

aggregatedList

Retrieves the list of Instance resources across all available zones.

attachDisk

Attaches a Disk resource to an instance.

delete

Deletes the specified Instance resource. For more information, see Shutting down an instance.

deleteAccessConfig

Deletes an access config from an instance's network interface.

detachDisk

Detaches a disk from an instance.

get

Returns the specified instance resource.

getSerialPortOutput

Returns the specified instance's serial port output.

insert

Creates an instance resource in the specified project using the data included in the request.

list

Retrieves the list of instance resources contained within the specified zone.

reset

Performs a hard reset on the instance.

setDiskAutoDelete

Sets the auto-delete flag for a disk attached to an instance.

setMetadata

Sets metadata for the specified instance to the data included in the request.

setScheduling

Sets an instance's scheduling options.

setTags

Sets tags for the specified instance to the data included in the request.

start

This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

stop

This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.