Method: forwardingRules.get

HTTP request
Path parameters
Request body
Response body
- JSON representation
  - JSON representation
Authorization Scopes
IAM Permissions

Returns the specified ForwardingRule resource.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

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.

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:

Represents a Forwarding Rule resource.

A forwardingRules resource represents a regional forwarding rule.

Regional external forwarding rules can reference any of the following resources:

A target instance
A Cloud VPN Classic gateway (targetVpnGateway),
A target pool for a Network Load Balancer
A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier
A target SSL proxy for a SSL Proxy load balancer using Standard Tier
A target TCP proxy for a TCP Proxy load balancer using Standard Tier.

Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer.

For regional internal forwarding rules, the following applies:

If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service.
If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy.

For more information, read Using Forwarding rules.

A globalForwardingRules resource represents a global forwarding rule.

Global forwarding rules are only used by load balancers that use Premium Tier.

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, "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 } ] } ], "kind": string }

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,
  "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
        }
      ]
    }
  ],
  "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.
`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.
`IPProtocol`	`enum` The IP protocol to which this rule applies. Valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. When the load balancing scheme is `INTERNAL`, only `TCP` and `UDP` are valid. When the load balancing scheme is `INTERNAL_SELF_MANAGED`, only `TCP`is valid.
`portRange`	`string` This field is deprecated. See the `port field.`
`ports[]`	`string` globalOperations.list of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints: TargetHttpProxy: 80, 8080 TargetHttpsProxy: 443 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 If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways: A list of up to five ports, which can be non-contiguous Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. The `ports` field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. @pattern: \d+(?:-\d+)? For more information, refer to Port specifications.
`target`	`string` The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live 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 `INTERNAL_SELF_MANAGED` load balancing, only HTTP and HTTPS targets are valid.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`loadBalancingScheme`	`enum` This signifies what the ForwardingRule will be used for and can only take the following values: `INTERNAL`, `INTERNAL_SELF_MANAGED`, `EXTERNAL`. The value of `INTERNAL` means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of `INTERNAL_SELF_MANAGED` means that this will be used for Internal Global HTTP(S) LB. The value of `EXTERNAL` means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
`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` and `INTERNAL_SELF_MANAGED` 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.
`backendService`	`string` This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
`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 to apply to this resource. These can be later 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 xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available 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 in the provided metadata. `metadataFilters` specified here can be overridden by 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 `filterLabel`s 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.
`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 Google IAM permissions:

compute.forwardingRules.get

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

Was this page helpful? Let us know how we did:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated September 10, 2019.

Method: forwardingRules.get

HTTP request

Path parameters

Request body

Response body

Authorization Scopes

IAM Permissions

Send feedback about...