- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves a list of ForwardingRule resources available to the specified project and region.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/forwardingRules
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
region
|
Name of the region scoping 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 ForwardingRule 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 , "name" : string , "description" : string , "region" : string , "IPAddress" : string , "IPProtocol" : enum , "portRange" : string , "ports" : [ string ] , "target" : string , "selfLink" : string , "loadBalancingScheme" : enum , "subnetwork" : string , "network" : string , "backendService" : string , "serviceDirectoryRegistrations" : [ { "namespace" : string , "service" : string , "serviceDirectoryRegion" : string } ] , "serviceLabel" : string , "serviceName" : string , "networkTier" : enum , "labels" : { string : string , ... } , "labelFingerprint" : string , "ipVersion" : enum , "fingerprint" : string , "allPorts" : boolean , "allowGlobalAccess" : boolean , "metadataFilters" : [ { "filterMatchCriteria" : enum , "filterLabels" : [ { "name" : string , "value" : string } ] } ] , "isMirroringCollector" : boolean , "sourceIpRanges" : [ string ] , "pscConnectionId" : string , "pscConnectionStatus" : enum , "baseForwardingRule" : string , "allowPscGlobalAccess" : boolean , "noAutomateDnsZone" : boolean , "ipCollection" : string } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
kind
string
Type of resource.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items[]
object
A list of ForwardingRule resources.
items[].kind
string
[Output Only] Type of the resource. Always compute#forwardingRule
for forwarding rule resources.
items[].id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
items[].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.
For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
items[].description
string
An optional description of this resource. Provide this property when you create the resource.
items[].region
string
[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
items[].IPAddress
string
IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target
or backendService
. While creating a forwarding rule, specifying an IPAddress
is required under the following circumstances:
- When the
target
is set totargetGrpcProxy
andvalidateForProxyless
is set totrue
, theIPAddress
should be set to0.0.0.0
. - When the
target
is a Private Service Connect Google APIs bundle, you must specify anIPAddress
.
Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.
Use one of the following formats to specify an IP address while creating a forwarding rule:
- IP address number, as in
100.1.2.3
- IPv6 address range, as in
2600:1234::/96
- Full resource URL, as in
https://www.googleapis.com/compute/v1/projects/ projectId /regions/ region /addresses/ address-name
- Partial URL or by name, as in:
-
projects/ projectId /regions/ region /addresses/ address-name
-
regions/ region /addresses/ address-name
-
global/addresses/ address-name
-
address-name
-
The forwarding rule's target
or backendService
, and in most cases, also the loadBalancingScheme
, determine the type of IP address that you can use. For detailed information, see IP address specifications
.
When reading an IPAddress
, the API always returns the IP address number.
items[].IPProtocol
enum
The IP protocol to which this rule applies.
For protocol forwarding, valid options are TCP
, UDP
, ESP
, AH
, SCTP
, ICMP
and L3_DEFAULT
.
The valid IP protocols are different for different load balancing products as described in Load balancing features .
items[].portRange
string
The ports
, portRange
, and allPorts
fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The portRange
field has the following limitations:
- It requires that the forwarding rule
IPProtocol
be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
- Some products have restrictions on what ports can be used. See port specifications for details.
For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol]
pair, and cannot have overlapping portRange
s.
For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol]
pair, and cannot have overlapping portRange
s.
@pattern: \d+(?:-\d+)?
items[].ports[]
string
The ports
, portRange
, and allPorts
fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The ports
field has the following limitations:
- It requires that the forwarding rule
IPProtocol
be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
- You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.
For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol]
pair if they share at least one port number.
For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol]
pair if they share at least one port number.
@pattern: \d+(?:-\d+)?
items[].target
string
The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource.
The forwarded traffic must be of a type appropriate to the target object.
- For load balancers, see the "Target" column in Port specifications .
- For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
-
vpc-sc
- APIs that support VPC Service Controls . -
all-apis
- All supported Google APIs .
-
- For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
items[].selfLink
string
[Output Only] Server-defined URL for the resource.
items[].loadBalancingScheme
enum
Specifies the forwarding rule type.
For more information about forwarding rules, refer to Forwarding rule concepts .
items[].subnetwork
string
This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.
If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
items[].network
string
This field is not used for global external load balancing.
For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used.
For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
items[].backendService
string
Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
items[].serviceDirectoryRegistrations[]
object
Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
items[].serviceDirectoryRegistrations[].namespace
string
Service Directory namespace to register the forwarding rule under.
items[].serviceDirectoryRegistrations[].service
string
Service Directory service to register the forwarding rule under.
items[].serviceDirectoryRegistrations[].serviceDirectoryRegion
string
[Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs forwarding rules on the same network should use the same Service Directory region.
items[].serviceLabel
string
An optional prefix to the service name for this forwarding rule. If specified, the prefix is the first label of the fully qualified service name.
The label must be 1-63 characters long, and comply with RFC1035
. Specifically, the label 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.
This field is only used for internal load balancing.
items[].serviceName
string
[Output Only] The internal fully qualified service name for this forwarding rule.
This field is only used for internal load balancing.
items[].networkTier
enum
This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM
, STANDARD
.
For regional ForwardingRule, the valid values are PREMIUM
and STANDARD
. For GlobalForwardingRule, the valid value is PREMIUM
.
If this field is not specified, it is assumed to be PREMIUM
. If IPAddress
is specified, this value must be equal to the networkTier of the Address.
items[].labels
map (key: string, value: string)
Labels for this resource. These can only be added or modified by the setLabels
method. Each label key/value pair must comply with RFC1035
. Label values may be empty.
items[].labelFingerprint
string ( bytes
format)
A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet
.
To see the latest fingerprint, make a get()
request to retrieve a ForwardingRule.
A base64-encoded string.
items[].ipVersion
enum
The IP Version that will be used by this forwarding rule. Valid options are IPV4
or IPV6
.
items[].fingerprint
string ( bytes
format)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request.
To see the latest fingerprint, make a get()
request to retrieve a ForwardingRule.
A base64-encoded string.
items[].allPorts
boolean
The ports
, portRange
, and allPorts
fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The allPorts
field has the following limitations:
- It requires that the forwarding rule
IPProtocol
be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
- Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires
allPorts
be set to true.
items[].allowGlobalAccess
boolean
If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
items[].metadataFilters[]
object
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS
compliant clients. In their xDS requests to load balancer, xDS clients present node metadata
. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy
, UrlMap
) referenced by the ForwardingRule
are not visible to those proxies.
For each metadataFilter
in this list, if its filterMatchCriteria
is set to MATCH_ANY, at least one of the filterLabel
s must match the corresponding label provided in the metadata. If its filterMatchCriteria
is set to MATCH_ALL, then all of its filterLabel
s must match with corresponding labels provided in the metadata. If multiple metadataFilters
are specified, all of them need to be satisfied in order to be considered a match.
metadataFilters
specified here will be applifed before those specified in the UrlMap
that this ForwardingRule
references.
metadataFilters
only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED
.
items[].metadataFilters[].filterMatchCriteria
enum
Specifies how individual filter label matches within the list of filterLabels
and contributes toward the overall metadataFilter
match.
Supported values are:
-
MATCH_ANY
: at least one of thefilterLabels
must have a matching label in the provided metadata. -
MATCH_ALL
: allfilterLabels
must have matching labels in the provided metadata.
items[].metadataFilters[].filterLabels[]
object
The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria
This list must not be empty and can have at the most 64 entries.
items[].metadataFilters[].filterLabels[].name
string
Name of metadata label.
The name can have a maximum length of 1024 characters and must be at least 1 character long.
items[].metadataFilters[].filterLabels[].value
string
The value of the label must match the specified value.
value can have a maximum length of 1024 characters.
items[].isMirroringCollector
boolean
Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring
rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme
set to INTERNAL
.
items[].sourceIpRanges[]
string
If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme is EXTERNAL
. Each sourceIpRange
entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
items[].pscConnectionId
string ( uint64
format)
[Output Only] The PSC connection id of the PSC forwarding rule.
items[].pscConnectionStatus
enum
items[].baseForwardingRule
string
[Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.
items[].allowPscGlobalAccess
boolean
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
items[].noAutomateDnsZone
boolean
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.
items[].ipCollection
string
Resource reference of a PublicDelegatedPrefix
. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/
projectId
/regions/ region
/publicDelegatedPrefixes/ sub-pdp-name
Partial URL, as in:
-
projects/ projectId /regions/ region /publicDelegatedPrefixes/ sub-pdp-name
-
regions/ region /publicDelegatedPrefixes/ sub-pdp-name
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.
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.forwardingRules.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .