Method: forwardingRules.get

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

Returns the specified ForwardingRule resource.

HTTP request

GET https://www.googleapis.com/compute/v1/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, "ipVersion": enum, "allPorts": boolean, "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,
  "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` The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (`EXTERNAL` or `INTERNAL`) and scope (global or regional). When the load balancing scheme is `EXTERNAL`, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is `INTERNAL_SELF_MANAGED`, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of `GCE_END_POINT` and addressType of `INTERNAL`. When the load balancing scheme is `INTERNAL`, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: `100.1.2.3` `https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address` `projects/project/regions/region/addresses/address` `regions/region/addresses/address` `global/addresses/address` `address`
`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 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'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports.
`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, will be 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.
`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

Esta página foi útil? Conte sua opinião sobre:

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.

Última atualização: Junho 18, 2019.

Method: forwardingRules.get

HTTP request

Path parameters

Request body

Response body

Authorization Scopes

IAM Permissions

Enviar comentários sobre…