Method: packetMirrorings.aggregatedList

Retrieves an aggregated list of packetMirrorings.

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

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/packetMirrorings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

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)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
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.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber

string (int64 format)

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Request body

The request body must be empty.

Response body

Contains a list of packetMirrorings.

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "packetMirrorings": [
        {
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "selfLink": string,
          "name": string,
          "description": string,
          "region": string,
          "network": {
            "url": string,
            "canonicalUrl": string
          },
          "priority": integer,
          "collectorIlb": {
            "url": string,
            "canonicalUrl": string
          },
          "mirroredResources": {
            "subnetworks": [
              {
                "url": string,
                "canonicalUrl": string
              }
            ],
            "instances": [
              {
                "url": string,
                "canonicalUrl": string
              }
            ],
            "tags": [
              string
            ]
          },
          "filter": {
            "cidrRanges": [
              string
            ],
            "IPProtocols": [
              string
            ],
            "direction": enum
          },
          "enable": enum
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    },
    ...
  },
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "unreachables": [
    string
  ]
}
Fields
kind

string

Type of resource.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items

map (key: string, value: object)

A list of PacketMirroring resources.

Key: Name of the scope containing this set of packetMirrorings.
items.packetMirrorings[]

object

A list of packetMirrorings contained in this scope.
items.packetMirrorings[].kind

string

[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
items.packetMirrorings[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.packetMirrorings[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
items.packetMirrorings[].selfLink

string

[Output Only] Server-defined URL for the resource.
items.packetMirrorings[].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.
items.packetMirrorings[].description

string

An optional description of this resource. Provide this property when you create the resource.
items.packetMirrorings[].region

string

[Output Only] URI of the region where the packetMirroring resides.
items.packetMirrorings[].network

object

Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
items.packetMirrorings[].network.url

string

URL of the network resource.
items.packetMirrorings[].network.canonicalUrl

string

[Output Only] Unique identifier for the network; defined by the server.
items.packetMirrorings[].priority

integer (uint32 format)

The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.

Default value is 1000. Valid range is 0 through 65535.
items.packetMirrorings[].collectorIlb

object

The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
items.packetMirrorings[].collectorIlb.url

string

Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.
items.packetMirrorings[].collectorIlb.canonicalUrl

string

[Output Only] Unique identifier for the forwarding rule; defined by the server.
items.packetMirrorings[].mirroredResources

object

PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
items.packetMirrorings[].mirroredResources.subnetworks[]

object

A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.

You may specify a maximum of 5 subnetworks.
items.packetMirrorings[].mirroredResources.subnetworks[].url

string

Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.
items.packetMirrorings[].mirroredResources.subnetworks[].canonicalUrl

string

[Output Only] Unique identifier for the subnetwork; defined by the server.
items.packetMirrorings[].mirroredResources.instances[]

object

A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.

Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.

You may specify a maximum of 50 Instances.
items.packetMirrorings[].mirroredResources.instances[].url

string

Resource URL to the virtual machine instance which is being mirrored.
items.packetMirrorings[].mirroredResources.instances[].canonicalUrl

string

[Output Only] Unique identifier for the instance; defined by the server.
items.packetMirrorings[].mirroredResources.tags[]

string

A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.
items.packetMirrorings[].filter

object

Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.
items.packetMirrorings[].filter.cidrRanges[]

string

One or more IPv4 or IPv6 CIDR ranges that apply as filters on the source (ingress) or destination (egress) IP in the IP header. If no ranges are specified, all IPv4 traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 traffic, use "0.0.0.0/0,::/0".
items.packetMirrorings[].filter.IPProtocols[]

string

Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored.
items.packetMirrorings[].filter.direction

enum

Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.
items.packetMirrorings[].enable

enum

Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.

The default is TRUE.
items.warning

object

Informational warning which replaces the list of packetMirrorings when the list is empty.
items.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.
items.warning.message

string

[Output Only] A human-readable description of the warning code.
items.warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
items.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).
items.warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
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.
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.
unreachables[]

string

[Output Only] Unreachable resources.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • 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 IAM permissions:

  • compute.packetMirrorings.list

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