- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves a list of PacketMirroring resources available to the specified project and region.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/packetMirrorings
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
region
|
Name of the region for this request. |
Query parameters
Parameters | |
---|---|
maxResults
|
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken
|
Specifies a page token to use. Set |
filter
|
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the 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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy
|
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 Currently, only sorting by |
returnPartialSuccess
|
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. |
Request body
The request body must be empty.
Response body
Contains a list of PacketMirroring resources.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "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 } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
Fields | |
---|---|
kind
|
[Output Only] Type of resource. Always |
id
|
[Output Only] Unique identifier for the resource; defined by the server. |
items[]
|
A list of PacketMirroring resources. |
items[].kind
|
[Output Only] Type of the resource. Always |
items[].id
|
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp
|
[Output Only] Creation timestamp in RFC3339 text format. |
items[].selfLink
|
[Output Only] Server-defined URL for the resource. |
items[].name
|
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 |
items[].description
|
An optional description of this resource. Provide this property when you create the resource. |
items[].region
|
[Output Only] URI of the region where the packetMirroring resides. |
items[].network
|
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[].network.url
|
URL of the network resource. |
items[].network.canonicalUrl
|
[Output Only] Unique identifier for the network; defined by the server. |
items[].priority
|
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[].collectorIlb
|
The Forwarding Rule resource of type |
items[].collectorIlb.url
|
Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic. |
items[].collectorIlb.canonicalUrl
|
[Output Only] Unique identifier for the forwarding rule; defined by the server. |
items[].mirroredResources
|
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[].mirroredResources.subnetworks[]
|
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[].mirroredResources.subnetworks[].url
|
Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored. |
items[].mirroredResources.subnetworks[].canonicalUrl
|
[Output Only] Unique identifier for the subnetwork; defined by the server. |
items[].mirroredResources.instances[]
|
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[].mirroredResources.instances[].url
|
Resource URL to the virtual machine instance which is being mirrored. |
items[].mirroredResources.instances[].canonicalUrl
|
[Output Only] Unique identifier for the instance; defined by the server. |
items[].mirroredResources.tags[]
|
A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored. |
items[].filter
|
Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored. |
items[].filter.cidrRanges[]
|
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[].filter.IPProtocols[]
|
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[].filter.direction
|
Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH. |
items[].enable
|
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. |
nextPageToken
|
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink
|
[Output Only] Server-defined URL for this resource. |
warning
|
[Output Only] Informational warning message. |
warning.code
|
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message
|
[Output Only] A human-readable description of the warning code. |
warning.data[]
|
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key
|
[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 |
warning.data[].value
|
[Output Only] A warning data value corresponding to the key. |
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 .