Method: globalForwardingRules.insert

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

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/global/forwardingRules

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters

Parameters
`requestId`	`string` An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).

requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request 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, "serviceLabel": string, "serviceName": string, "networkTier": enum, "ipVersion": enum, "allPorts": boolean, "metadataFilters": [ { "filterMatchCriteria": enum, "filterLabels": [ ] } ], "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,
  "metadataFilters": [
    {
      "filterMatchCriteria": enum,
      "filterLabels": [
        
      ]
    }
  ],
  "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` 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: IPv4 dotted decimal, as in `100.1.2.3` Full URL, as in `https://www.googleapis.com/compute/v1/projects/projectId/regions/region/addresses/address-name` Partial URL or by name, as in: `projects/projectId/regions/region/addresses/address-name` `regions/region/addresses/address-name` `global/addresses/address-name` `address-name` 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. Authorization requires the following Google IAM permission on the specified resource `IPAddress`: `compute.globalAddresses.use`
`IPProtocol`	`enum` The IP protocol to which this rule applies. Valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid.
`portRange`	`string` This field is deprecated. See the `port field.`
`ports[]`	`string` globalOperations.list of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints: 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 If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways: A list of up to five ports, which can be non-contiguous Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. The `ports` 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`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. @pattern: \d+(?:-\d+)? For more information, refer to Port specifications.
`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. Authorization requires one or more of the following Google IAM permissions on the specified resource `target`: `compute.targetHttpProxies.use` `compute.targetHttpsProxies.use` `compute.targetInstances.use` `compute.targetPools.use` `compute.targetSslProxies.use` `compute.targetTcpProxies.use` `compute.targetVpnGateways.use`
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`loadBalancingScheme`	`enum` Specifies the forwarding rule type. `EXTERNAL` is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP. `INTERNAL` is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers `INTERNAL_MANAGED` is used for: - Internal HTTP(S) load balancers `INTERNAL_SELF_MANAGED` is used for: - Traffic Director For more information about forwarding rules, refer to	`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. Authorization requires the following Google IAM permission on the specified resource `subnetwork`: `compute.subnetworks.use`
`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. Authorization requires the following Google IAM permission on the specified resource `network`: `compute.networks.use`
`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. Authorization requires the following Google IAM permission on the specified resource `backendService`: `compute.backendServices.use`
`serviceLabel`	`string` 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 `[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.
`metadataFilters[]`	`object` Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels in the provided metadata. `metadataFilters` specified here can be overridden by those specified in the `UrlMap` that this `ForwardingRule` references. `metadataFilters` only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`.
`metadataFilters[].filterMatchCriteria`	`enum` Specifies how individual `filterLabel` matches within the list of `filterLabel`s contribute towards the overall `metadataFilter` match. Supported values are: MATCH_ANY: At least one of the `filterLabels` must have a matching label in the provided metadata. MATCH_ALL: All `filterLabels` must have matching labels in the provided metadata.
`metadataFilters[].filterLabels[]`	`object` The list of label value pairs that must match labels in the provided metadata based on `filterMatchCriteria` This list must not be empty and can have at the most 64 entries.
`metadataFilters[].filterLabels[].name`	`string` 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`	`string` The value of the label must match the specified value. value can have a maximum length of 1024 characters.
`kind`	`string` [Output Only] Type of the resource. Always `compute#forwardingRule` for Forwarding Rule resources.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{ "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": number, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": number, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": number,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": number,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "kind": string
}

Fields
`id`	`string (fixed64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the operation.
`zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`targetLink`	`string` [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
`targetId`	`string (fixed64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`status`	`enum` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`statusMessage`	`string` [Output Only] An optional textual description of the current status of the operation.
`user`	`string` [Output Only] User who requested the operation, for example: `user@example.com`.
`progress`	`number` [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`endTime`	`string` [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`error`	`object` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`error.errors[]`	`object` [Output Only] The array of errors encountered while processing this operation.
`error.errors[].code`	`string` [Output Only] The error type identifier for this error.
`error.errors[].location`	`string` [Output Only] Indicates the field in the request that caused the error. This property is optional.
`error.errors[].message`	`string` [Output Only] An optional, human-readable error message.
`warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`warnings[].code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`warnings[].message`	`string` [Output Only] A human-readable description of the warning code.
`warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warnings[].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).
`warnings[].data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`httpErrorStatusCode`	`number` [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
`httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation 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.globalForwardingRules.create

Was this page helpful? Let us know how we did:

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.

Last updated October 16, 2019.