Resource: ForwardingRule
Represents a Forwarding Rule resource.
Forwarding rule resources in Google Cloud can be either regional or global in scope:
A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud 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 |
---|
{ "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 } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 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. |
description |
An optional description of this resource. Provide this property when you create the resource. |
region |
[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 |
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
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:
The forwarding rule's When reading an |
IPProtocol |
The IP protocol to which this rule applies. For protocol forwarding, valid options are The valid IP protocols are different for different load balancing products as described in Load balancing features. |
portRange |
The The
For external forwarding rules, two or more forwarding rules cannot use the same For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same @pattern: \d+(?:-\d+)? |
ports[] |
The The
For external forwarding rules, two or more forwarding rules cannot use the same For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same @pattern: \d+(?:-\d+)? |
target |
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.
|
selfLink |
[Output Only] Server-defined URL for the resource. |
loadBalancingScheme |
Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. |
subnetwork |
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. |
network |
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. |
backendService |
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. |
serviceDirectoryRegistrations[] |
Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. |
serviceDirectoryRegistrations[].namespace |
Service Directory namespace to register the forwarding rule under. |
serviceDirectoryRegistrations[].service |
Service Directory service to register the forwarding rule under. |
serviceDirectoryRegistrations[].serviceDirectoryRegion |
[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. |
serviceLabel |
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 This field is only used for internal load balancing. |
serviceName |
[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing. |
networkTier |
This signifies the networking tier used for configuring this load balancer and can only take the following values: For regional ForwardingRule, the valid values are If this field is not specified, it is assumed to be |
labels |
Labels for this resource. These can only be added or modified by the |
labelFingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
ipVersion |
The IP Version that will be used by this forwarding rule. Valid options are |
fingerprint |
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 A base64-encoded string. |
allPorts |
The The
|
allowGlobalAccess |
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. |
metadataFilters[] |
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. For each |
metadataFilters[].filterMatchCriteria |
Specifies how individual filter label matches within the list of Supported values are:
|
metadataFilters[].filterLabels[] |
The list of label value pairs that must match labels in the provided metadata based on This list must not be empty and can have at the most 64 entries. |
metadataFilters[].filterLabels[].name |
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 |
The value of the label must match the specified value. value can have a maximum length of 1024 characters. |
isMirroringCollector |
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 |
sourceIpRanges[] |
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 |
pscConnectionId |
[Output Only] The PSC connection id of the PSC forwarding rule. |
pscConnectionStatus |
|
baseForwardingRule |
[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. |
allowPscGlobalAccess |
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. |
noAutomateDnsZone |
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. |
ipCollection |
Resource reference of a 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
|
Methods |
|
---|---|
|
Deletes the specified GlobalForwardingRule resource. |
|
Returns the specified GlobalForwardingRule resource. |
|
Creates a GlobalForwardingRule resource in the specified project using the data included in the request. |
|
Retrieves a list of GlobalForwardingRule resources available to the specified project. |
|
Updates the specified forwarding rule with the data included in the request. |
|
Sets the labels on the specified resource. |
|
Changes target URL for the GlobalForwardingRule resource. |