Method: forwardingRules.get

Returns the specified ForwardingRule resource.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/forwardingRules/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region scoping this request.
resourceId

string

Name of the ForwardingRule resource to return.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "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
    }
  ],
  "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,
  "kind": string
}
Fields
id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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 an 1-20 characters string with lowercase letters and numbers and must start with a letter.
description

string

An optional description of this resource. Provide this property when you create the resource.
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.
IPAddress

string

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.

If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:

  • IPv4 dotted decimal, as in 100.1.2.3
  • Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to IP address specifications.

Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true.

For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.
IPProtocol

enum

The IP protocol to which this rule applies.

For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP and ICMP.

The valid IP protocols are different for different load balancing products:

  • Internal TCP/UDP Load Balancing: The load balancing scheme is INTERNAL, and one of TCP, UDP or ALL is valid.
  • Traffic Director: The load balancing scheme is INTERNAL_SELF_MANAGED, and only TCP is valid.
  • Internal HTTP(S) Load Balancing: The load balancing scheme is INTERNAL_MANAGED, and only TCP is valid.
  • HTTP(S), SSL Proxy, and TCP Proxy Load Balancing: The load balancing scheme is EXTERNAL and only TCP is valid.
  • Network Load Balancing: The load balancing scheme is EXTERNAL, and one of TCP or UDP is valid.
portRange

string

This field can be used only if: * Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED, and * IPProtocol is one of TCP, UDP, or SCTP.

Packets addressed to ports in the specified range will be forwarded to target or backendService. You can only use one of ports, portRange, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

Some types of forwarding target have constraints on the acceptable ports:

  • TargetHttpProxy: 80, 8080
  • TargetHttpsProxy: 443
  • TargetGrpcProxy: no constraints
  • TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetVpnGateway: 500, 4500

@pattern: \d+(?:-\d+)?
ports[]

string

The ports field is only supported when the forwarding rule references a backendService directly. Supported load balancing products are Internal TCP/UDP Load Balancing and Network Load Balancing. Only packets addressed to the specified list of ports are forwarded to backends.

You can only use one of ports and portRange, or allPorts. The three are mutually exclusive.

You can specify a list of up to five ports, which can be non-contiguous.

For Internal TCP/UDP Load Balancing, if you specify allPorts, you should not specify ports.

For more information, see Port specifications.

@pattern: \d+(?:-\d+)?
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 more information, 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. Currently, the supported Google API bundles include:
loadBalancingScheme

enum

Specifies the forwarding rule type.

  • EXTERNAL is used for:
    • Classic Cloud VPN gateways
    • Protocol forwarding to VMs from an external IP address
    • HTTP(S), SSL Proxy, TCP Proxy, and Network Load Balancing
  • INTERNAL is used for:
    • Protocol forwarding to VMs from an internal IP address
    • Internal TCP/UDP Load Balancing
  • INTERNAL_MANAGED is used for:
    • Internal HTTP(S) Load Balancing
  • INTERNAL_SELF_MANAGED is used for:
    • Traffic Director

For more information about forwarding rules, refer to Forwarding rule concepts.
subnetwork

string

This field is only used for internal load balancing.

For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.

If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
network

string

This field is not used for external load balancing.

For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
backendService

string

Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
serviceDirectoryRegistrations[]

object

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

It is only supported for Internal TCP/UDP Load Balancing and Internal HTTP(S) Load Balancing.
serviceDirectoryRegistrations[].namespace

string

Service Directory namespace to register the forwarding rule under.
serviceDirectoryRegistrations[].service

string

Service Directory service to register the forwarding rule under.
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.
serviceName

string

[Output Only] The internal fully qualified service name for this Forwarding Rule.

This field is only used for internal load balancing.
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.
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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.
ipVersion

enum

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.
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.
allPorts

boolean

This field is used along with the backendService field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.

When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule.
allowGlobalAccess

boolean

This field is used along with the backendService field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
metadataFilters[]

object

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, 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 will not be visible to those proxies.

For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels 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.
metadataFilters[].filterMatchCriteria

enum

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

Supported values are:

  • MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.
  • MATCH_ALL: All filterLabels must have matching labels in the provided metadata.
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.
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.
metadataFilters[].filterLabels[].value

string

The value of the label must match the specified value.

value can have a maximum length of 1024 characters.
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.
kind

string

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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.get

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