Method: regionNetworkPolicies.aggregatedList

Retrieves an aggregated list of network policies.

To prevent failure, it's recommended that you set the returnPartialSuccess parameter to true.

HTTP request

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

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

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

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "networkPolicies": [
        {
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "trafficClassificationRules": [
            {
              "kind": string,
              "ruleName": string,
              "description": string,
              "priority": integer,
              "match": {
                "srcIpRanges": [
                  string
                ],
                "destIpRanges": [
                  string
                ],
                "layer4Configs": [
                  {
                    "ipProtocol": string,
                    "ports": [
                      string
                    ]
                  }
                ]
              },
              "action": {
                "type": string,
                "trafficClass": enum,
                "dscpMode": enum,
                "dscpValue": integer
              },
              "ruleTupleCount": integer,
              "targetServiceAccounts": [
                string
              ],
              "targetSecureTags": [
                {
                  "name": string,
                  "state": enum
                }
              ],
              "disabled": boolean
            }
          ],
          "selfLink": string,
          "selfLinkWithId": string,
          "associations": [
            {
              "name": string,
              "attachmentTarget": string
            }
          ],
          "ruleTupleCount": integer,
          "region": string
        }
      ],
      "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

[Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies.
id

string

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

map (key: string, value: object)

A list of NetworkPoliciesScopedList resources.

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

object

A list of network policies contained in this scope.
items.networkPolicies[].kind

string

[Output only] Type of the resource. Always compute#networkPolicy for network policies
items.networkPolicies[].id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items.networkPolicies[].name

string

Name of the resource.
items.networkPolicies[].description

string

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

object

[Output Only] A list of traffic classification rules that belong to this policy.
items.networkPolicies[].trafficClassificationRules[].kind

string

[Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
items.networkPolicies[].trafficClassificationRules[].ruleName

string

An optional name for the rule. This field is not a unique identifier and can be updated.
items.networkPolicies[].trafficClassificationRules[].description

string

An optional description for this resource.
items.networkPolicies[].trafficClassificationRules[].priority

integer

An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
items.networkPolicies[].trafficClassificationRules[].match

object

A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
items.networkPolicies[].trafficClassificationRules[].match.srcIpRanges[]

string

CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
items.networkPolicies[].trafficClassificationRules[].match.destIpRanges[]

string

CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
items.networkPolicies[].trafficClassificationRules[].match.layer4Configs[]

object

Pairs of IP protocols and ports that the rule should match.
items.networkPolicies[].trafficClassificationRules[].match.layer4Configs[].ipProtocol

string

The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
items.networkPolicies[].trafficClassificationRules[].match.layer4Configs[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for UDP, TCP or SCTP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
items.networkPolicies[].trafficClassificationRules[].action

object

The Action to perform when the client connection triggers the rule.
items.networkPolicies[].trafficClassificationRules[].action.type

string

Always "apply_traffic_classification" for traffic classification rules.
items.networkPolicies[].trafficClassificationRules[].action.trafficClass

enum

The traffic class that should be applied to the matching packet.
items.networkPolicies[].trafficClassificationRules[].action.dscpMode

enum

DSCP mode. When set to AUTO, the DSCP value will be picked automatically based on selected trafficClass. Otherwise, dscpValue needs to be explicitly specified.
items.networkPolicies[].trafficClassificationRules[].action.dscpValue

integer

Custom DSCP value from 0-63 range.
items.networkPolicies[].trafficClassificationRules[].ruleTupleCount

integer

[Output Only] Calculation of the complexity of a single network policy rule.
items.networkPolicies[].trafficClassificationRules[].targetServiceAccounts[]

string

A list of service accounts indicating the sets of instances that are applied with this rule.
items.networkPolicies[].trafficClassificationRules[].targetSecureTags[]

object

A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
items.networkPolicies[].trafficClassificationRules[].targetSecureTags[].name

string

Name of the secure tag, created with TagManager's TagValue API.
items.networkPolicies[].trafficClassificationRules[].targetSecureTags[].state

enum

[Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted.
items.networkPolicies[].trafficClassificationRules[].disabled

boolean

Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
items.networkPolicies[].selfLink

string

[Output Only] Server-defined URL for the resource.
items.networkPolicies[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.
items.networkPolicies[].associations[]

object

[Output Only] A list of associations that belong to this network policy.
items.networkPolicies[].associations[].name

string

The name for an association.
items.networkPolicies[].associations[].attachmentTarget

string

The target that the network policy is attached to.
items.networkPolicies[].ruleTupleCount

integer

[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
items.networkPolicies[].region

string

[Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
items.warning

object

Informational warning which replaces the list of network policies 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.regionNetworkPolicies.list

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