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

Successful response

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 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. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 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] The type of the resource. Always compute#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.
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] 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.

list

Successful response

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	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 than maxResults, 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] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Successful response

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 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. (pattern: a-z?)
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 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] The type of the resource. Always compute#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.
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] 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	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of TargetInstance resources available to the specified project and zone.
aggregated_list	select	project	filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber	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, see Google 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

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;

list

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 filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

aggregated_list

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 filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';

INSERT examples

insert

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

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

Manifest

# Description fields are for documentation purposes
- name: target_instances
  props:
    - name: project
      value: string
      description: Required parameter for the target_instances resource.
    - name: zone
      value: string
      description: Required parameter for the target_instances resource.
    - name: kind
      value: string
      description: >
        [Output Only] The type of the resource. Always compute#targetInstance for target instances.
        
      default: compute#targetInstance
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: zone
      value: string
      description: >
        [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: natPolicy
      value: string
      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: string
      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: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: network
      value: string
      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: securityPolicy
      value: string
      description: >
        [Output Only] The resource URL for the security policy associated with this target instance.
        
    - name: requestId
      value: string

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, see Google 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 }}"
}';