REST Resource: globalForwardingRules

Resource: ForwardingRule
- JSON representation
  - JSON representation
Methods

Resource: ForwardingRule

Represents a Forwarding Rule resource.

A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway).

For more information, read Forwarding rule concepts and Using protocol forwarding.

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, "ipVersion": enum, "allPorts": 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,
  "ipVersion": enum,
  "allPorts": 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. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid.
`portRange`	`string` When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `portRange`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This 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`, only packets addressed to ports in the specified range will be forwarded to `target`. 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 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` This field is used along with the `backendService` field for internal load balancing. When the load balancing scheme is `INTERNAL`, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can 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. @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` Specifies the forwarding rule type. `EXTERNAL` is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP. `INTERNAL` is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers `INTERNAL_MANAGED` is used for: - Internal HTTP(S) load balancers `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` 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.
`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.
`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.
`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. If a match takes place, 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.` `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 `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.

Methods
`delete`	Deletes the specified GlobalForwardingRule resource.
`get`	Returns the specified GlobalForwardingRule resource.
`insert`	Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
`list`	Retrieves a list of GlobalForwardingRule resources available to the specified project.
`patch`	Updates the specified forwarding rule with the data included in the request.
`setLabels`	Sets the labels on the specified resource.
`setTarget`	Changes target URL for the GlobalForwardingRule resource.
`testIamPermissions`	Returns permissions that a caller has on the specified resource.

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 December 5, 2019.

REST Resource: globalForwardingRules

Resource: ForwardingRule

Methods

`delete`

`get`

`insert`

`list`

`patch`

`setLabels`

`setTarget`

`testIamPermissions`

Send feedback about...