Skip to main content

instances_referrers

Creates, updates, deletes, gets or lists an instances_referrers resource.

Overview

Nameinstances_referrers
TypeResource
Idgoogle.compute.instances_referrers

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring[Output Only] Unique identifier for the resource; defined by the server.
itemsarrayA list of Reference resources.
kindstringOutput only. [Output Only] Type of resource. Alwayscompute#instanceListReferrers for lists of Instance referrers. (default: compute#instanceListReferrers)
nextPageTokenstring[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.
selfLinkstringOutput only. [Output Only] Server-defined URL for this resource.
warningobject[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_referrersselectproject, zone, instanceorderBy, maxResults, pageToken, filter, returnPartialSuccessRetrieves a list of resources that refer to the VM instance specified in
the request. For example, if the VM instance is part of a managed or
unmanaged instance group, the referrers list includes the instance group.
For more information, readViewing
referrers to VM instances.

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.

NameDatatypeDescription
instancestring
projectstring
zonestring
filterstring
maxResultsinteger (uint32)
orderBystring
pageTokenstring
returnPartialSuccessboolean

SELECT examples

Retrieves a list of resources that refer to the VM instance specified in
the request. For example, if the VM instance is part of a managed or
unmanaged instance group, the referrers list includes the instance group.
For more information, readViewing
referrers to VM instances.

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