target_instances

Creates, updates, deletes, gets or lists a target_instances resource.

Overview

Name	`target_instances`
Type	Resource
Id	`google.compute.target_instances`

Fields

The following fields are returned by SELECT queries:

get
list
aggregated_list

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance
`kind`	`string`	Output only. [Output Only] The type of the resource. Alwayscompute#targetInstance for target instances. (default: compute#targetInstance)
`natPolicy`	`string`	Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. (NO_NAT)
`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.
`securityPolicy`	`string`	[Output Only] The resource URL for the security policy associated with this target instance.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`zone`	`string`	Output only. [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.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of TargetInstance resources.
`kind`	`string`	Output only. Type of resource. (default: compute#targetInstanceList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`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 withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`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: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance
`kind`	`string`	Output only. [Output Only] The type of the resource. Alwayscompute#targetInstance for target instances. (default: compute#targetInstance)
`natPolicy`	`string`	Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. (NO_NAT)
`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.
`securityPolicy`	`string`	[Output Only] The resource URL for the security policy associated with this target instance.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`zone`	`string`	Output only. [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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `zone`, `targetInstance`		Returns the specified TargetInstance resource.
`list`	`select`	`project`, `zone`	`returnPartialSuccess`, `maxResults`, `pageToken`, `filter`, `orderBy`	Retrieves a list of TargetInstance resources available to the specified project and zone.
`aggregated_list`	`select`	`project`	`maxResults`, `pageToken`, `filter`, `serviceProjectNumber`, `includeAllScopes`, `orderBy`, `returnPartialSuccess`	Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`insert`	`insert`	`project`, `zone`	`requestId`	Creates a TargetInstance resource in the specified project and zone using the data included in the request.
`delete`	`delete`	`project`, `zone`, `targetInstance`	`requestId`	Deletes the specified TargetInstance resource.
`set_security_policy`	`exec`	`project`, `zone`, `targetInstance`	`requestId`	Sets the Google Cloud Armor security policy for the specified target instance. For more information, seeGoogle Cloud Armor Overview

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`project`	`string`
`targetInstance`	`string`
`zone`	`string`
`filter`	`string`
`includeAllScopes`	`boolean`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`serviceProjectNumber`	`string (int64)`

`SELECT` examples

get
list
aggregated_list

Returns the specified TargetInstance resource.

SELECT
id,
name,
creationTimestamp,
description,
instance,
kind,
natPolicy,
network,
securityPolicy,
selfLink,
zone
FROM google.compute.target_instances
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND targetInstance = '{{ targetInstance }}' -- required
;

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

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.target_instances
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

Retrieves an aggregated list of target instances.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
description,
instance,
kind,
natPolicy,
network,
securityPolicy,
selfLink,
zone
FROM google.compute.target_instances
WHERE project = '{{ project }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

`INSERT` examples

insert
Manifest

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

INSERT INTO google.compute.target_instances (
data__name,
data__securityPolicy,
data__natPolicy,
data__instance,
data__description,
data__id,
data__network,
data__selfLink,
project,
zone,
requestId
)
SELECT 
'{{ name }}',
'{{ securityPolicy }}',
'{{ natPolicy }}',
'{{ instance }}',
'{{ description }}',
'{{ id }}',
'{{ network }}',
'{{ selfLink }}',
'{{ project }}',
'{{ zone }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: target_instances
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the target_instances resource.
  - name: zone
    value: "{{ zone }}"
    description: Required parameter for the target_instances resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: securityPolicy
    value: "{{ securityPolicy }}"
    description: |
      [Output Only] The resource URL for the security policy associated with this
      target instance.
  - name: natPolicy
    value: "{{ natPolicy }}"
    description: |
      Must have a value of NO_NAT.
      Protocol forwarding delivers packets while preserving the destination IP
      address of the forwarding rule referencing the target instance.
    valid_values: ['NO_NAT']
  - name: instance
    value: "{{ instance }}"
    description: |
      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:
      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
      - projects/project/zones/zone/instances/instance
      - zones/zone/instances/instance
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: network
    value: "{{ network }}"
    description: |
      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.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes the specified TargetInstance resource.

DELETE FROM google.compute.target_instances
WHERE project = '{{ project }}' --required
AND zone = '{{ zone }}' --required
AND targetInstance = '{{ targetInstance }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_security_policy

Sets the Google Cloud Armor security policy for the specified target
instance. For more information, seeGoogle
Cloud Armor Overview

EXEC google.compute.target_instances.set_security_policy 
@project='{{ project }}' --required, 
@zone='{{ zone }}' --required, 
@targetInstance='{{ targetInstance }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"securityPolicy": "{{ securityPolicy }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​