REST Resource: targetInstances

Resource: TargetInstance

Represents a Target Instance resource.

You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "zone": string,
  "natPolicy": enum,
  "instance": string,
  "selfLink": string,
  "network": string,
  "kind": string
}
Fields
id

string (fixed64 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.

zone

string

[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

natPolicy

enum

NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.

instance

string

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:

network

string

The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

kind

string

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

Methods

aggregatedList

Retrieves an aggregated list of target instances.

delete

Deletes the specified TargetInstance resource.

get

Returns the specified TargetInstance resource.

insert

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

list

Retrieves a list of TargetInstance resources available to the specified project and zone.

testIamPermissions

Returns permissions that a caller has on the specified resource.