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 } |
Fields | |
---|---|
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 |
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 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:
|
IPProtocol |
The IP protocol to which this rule applies. For protocol forwarding, valid options are For Internal TCP/UDP Load Balancing, the load balancing scheme is |
portRange |
When the load balancing scheme is Applicable only when Some types of forwarding target have constraints on the acceptable ports:
@pattern: \d+(?:-\d+)? |
ports[] |
This field is used along with the When the load balancing scheme is If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways:
@pattern: \d+(?:-\d+)? For more information, refer to Port specifications. |
target |
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 |
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 is only used for 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 |
This field is not used for external load balancing. For |
backendService |
This field is only used for For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. |
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 |
ipVersion |
The IP Version that will be used by this forwarding rule. Valid options are |
allPorts |
This field is used along with the When the load balancing scheme is |
metadataFilters[] |
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. For each |
metadataFilters[].filterMatchCriteria |
Specifies how individual 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. |
kind |
[Output Only] Type of the resource. Always |
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. |
|
Returns permissions that a caller has on the specified resource. |