- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists all the policies that have been configured for the specified project in the given region.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/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 |
Project ID for this request. |
region |
Name of the region of 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
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": [ { "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 } ], "nextPageToken": 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 NetworkPolicy 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[].name |
Name of the resource. |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].trafficClassificationRules[] |
[Output Only] A list of traffic classification rules that belong to this policy. |
items[].trafficClassificationRules[].kind |
[Output only] Type of the resource. Always |
items[].trafficClassificationRules[].ruleName |
An optional name for the rule. This field is not a unique identifier and can be updated. |
items[].trafficClassificationRules[].description |
An optional description for this resource. |
items[].trafficClassificationRules[].priority |
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[].trafficClassificationRules[].match |
A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
items[].trafficClassificationRules[].match.srcIpRanges[] |
CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
items[].trafficClassificationRules[].match.destIpRanges[] |
CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
items[].trafficClassificationRules[].match.layer4Configs[] |
Pairs of IP protocols and ports that the rule should match. |
items[].trafficClassificationRules[].match.layer4Configs[].ipProtocol |
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 ( |
items[].trafficClassificationRules[].match.layer4Configs[].ports[] |
An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP 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: |
items[].trafficClassificationRules[].action |
The Action to perform when the client connection triggers the rule. |
items[].trafficClassificationRules[].action.type |
Always "apply_traffic_classification" for traffic classification rules. |
items[].trafficClassificationRules[].action.trafficClass |
The traffic class that should be applied to the matching packet. |
items[].trafficClassificationRules[].action.dscpMode |
The traffic class that should be applied to the matching packet. |
items[].trafficClassificationRules[].action.dscpValue |
Custom DSCP value from 0-63 range. |
items[].trafficClassificationRules[].ruleTupleCount |
[Output Only] Calculation of the complexity of a single network policy rule. |
items[].trafficClassificationRules[].targetServiceAccounts[] |
A list of service accounts indicating the sets of instances that are applied with this rule. |
items[].trafficClassificationRules[].targetSecureTags[] |
A list of secure tags that controls which instances the traffic classification rule applies to. If |
items[].trafficClassificationRules[].targetSecureTags[].name |
Name of the secure tag, created with TagManager's TagValue API. |
items[].trafficClassificationRules[].targetSecureTags[].state |
[Output Only] State of the secure tag, either |
items[].trafficClassificationRules[].disabled |
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[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].selfLinkWithId |
[Output Only] Server-defined URL for this resource with the resource id. |
items[].associations[] |
[Output Only] A list of associations that belong to this network policy. |
items[].associations[].name |
The name for an association. |
items[].associations[].attachmentTarget |
The target that the network policy is attached to. |
items[].ruleTupleCount |
[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples. |
items[].region |
[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. |
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 |
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.regionNetworkPolicies.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.