Method: instances.listReferrers

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
• Authorization Scopes
• IAM Permissions

Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances/{resourceId}/referrers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project	string Project ID for this request.
zone	string The name of the zone for this request.
resourceId	string Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.

Query parameters

Parameters
maxResults	number (uint32 format) The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken	string Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter	string A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
orderBy	string Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "id": string, "items": [ { "target": string, "referenceType": string, "referrer": string, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string }

Fields
id	string [Output Only] Unique identifier for the resource; defined by the server.
items[]	object A list of Reference resources.
items[].target	string URL of the resource to which this reference points.
items[].referenceType	string A description of the reference type with no implied semantics. Possible values include: MEMBER_OF
items[].referrer	string URL of the resource which refers to the target.
items[].kind	string [Output Only] Type of the resource. Always compute#reference for references.
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.
warning.code	enum [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message	string [Output Only] A human-readable description of the warning code.
warning.data[]	object [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
warning.data[].key	string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value	string [Output Only] A warning data value corresponding to the key.
kind	string [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

Authorization Scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

• compute.instances.listReferrers

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.