- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
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 |
Project ID for this request. |
region |
Name of the region scoping this request. |
resourceId |
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, "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, "pscConnectionId": 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 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 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:
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 For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided. |
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:
|
portRange |
This field can be used only if: * Load balancing scheme is one of Packets addressed to ports in the specified range will be forwarded to Some types of forwarding target have constraints on the acceptable ports:
@pattern: \d+(?:-\d+)? |
ports[] |
The You can only use one of You can specify a list of up to five ports, which can be non-contiguous. For Internal TCP/UDP Load Balancing, if you specify For more information, see Port specifications. @pattern: \d+(?:-\d+)? |
target |
|
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 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 |
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 |
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[] |
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 |
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 An object containing a list of |
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 |
This field is used along with the When the load balancing scheme is |
allowGlobalAccess |
This field is used along with the |
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. 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 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 |
pscConnectionId |
[Output Only] The PSC connection id of the PSC Forwarding Rule. |
kind |
[Output Only] Type of the resource. Always |
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.