ForwardingRules: aggregatedList

Requires authorization

Retrieves an aggregated list of forwarding rules.

Request

HTTP request

GET https://www.googleapis.com/compute/v1/projects/project/aggregated/forwardingRules

Parameters

Parameter name Value Description
Path parameters
project string Project ID for this request.
Optional query parameters
filter string Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned integer The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
orderBy string Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
pageToken string Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#forwardingRuleAggregatedList",
  "id": string,
  "items": {
    (key): {
      "forwardingRules": [
        {
          "kind": "compute#forwardingRule",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "region": string,
          "IPAddress": string,
          "IPProtocol": string,
          "portRange": string,
          "ports": [
            string
          ],
          "target": string,
          "selfLink": string,
          "loadBalancingScheme": string,
          "subnetwork": string,
          "network": string,
          "backendService": string,
          "ipVersion": string
        }
      ],
      "warning": {
        "code": string,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    }
  },
  "nextPageToken": string,
  "selfLink": string
}
Property name Value Description Notes
kind string [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.
id string [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items object [Output Only] A map of scoped forwarding rule lists.
items.(key) nested object [Output Only] Name of the scope containing this set of addresses.
items.(key).forwardingRules[] list [Output Only] List of forwarding rules contained in this scope.
items.(key).warning object [Output Only] Informational warning which replaces the list of forwarding rules when the list is empty.
items.(key).warning.code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
items.(key).warning.message string [Output Only] A human-readable description of the warning code.
items.(key).warning.data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.(key).warning.data[].key string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
items.(key).warning.data[].value string [Output Only] A warning data value corresponding to the key.
nextPageToken string [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
items.(key).forwardingRules[].kind string [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
items.(key).forwardingRules[].id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.(key).forwardingRules[].creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
items.(key).forwardingRules[].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.
items.(key).forwardingRules[].description string An optional description of this resource. Provide this property when you create the resource.
items.(key).forwardingRules[].region string [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
items.(key).forwardingRules[].IPAddress string The IP address that this forwarding rule is serving on behalf of.

For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and 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, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
items.(key).forwardingRules[].IPProtocol string 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.
items.(key).forwardingRules[].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
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995
  • TargetVpnGateway: 500, 4500


items.(key).forwardingRules[].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.

This field is not used for internal load balancing.
items.(key).forwardingRules[].ports[] list This field is used along with the backend_service field for internal load balancing.

When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. 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.

items.(key).forwardingRules[].loadBalancingScheme string This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
items.(key).forwardingRules[].subnetwork string This field is not used for external 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.
items.(key).forwardingRules[].network string This field is not used for external load balancing.

For internal 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.
items.(key).forwardingRules[].backendService string This field is not used for external load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
items.(key).forwardingRules[].ipVersion string The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule.

Send feedback about...

Compute Engine