NetworkInstance

A network instance describes an external client that is using the network.

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "type": enum (Type),
  "networkInterfaces": [
    {
      object (NetworkInstanceNetworkInterface)
    }
  ],
  "status": enum (Status)
}
Fields
kind

string

Output only. Type of the resource. Always

compute#networkInstance

for network instances.

id

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

Output only. Creation timestamp in RFC3339 text format.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

description

string

An optional description of this resource. Provide this property when you create the resource.

type

enum (Type)

networkInterfaces[]

object (NetworkInstanceNetworkInterface)

A list of network interfaces associated with the instance. It contains information about networks the network instance is connected to.

status

enum (Status)

Output only. Status of the NetworkInstance. It is output only and possible values are RUNNING and ORPHANED. The initial status is RUNNING. Same project NetworkInstances will be deleted with the project when the project is deprovisioned without changing status explicitly. In the XPN usecase, when the network of the NetworkInstance is deleted because of host project deprovision, the status of NetworkInstances using this network will be set to ORPHANED to notify clients watching NetworkInstances to react.

NetworkInstanceNetworkInterface

Stores information about the network the network instance is connected to.

JSON representation
{
  "network": string,
  "metadata": string,
  "networkId": integer
}
Fields
network

string

metadata

string (bytes format)

An optional metadata stored for the client.

A base64-encoded string.

networkId

integer (uint32 format)

Output only. The 28 bit ID associated with the network.