Method: globalForwardingRules.insert

HTTP request
Path parameters
Query parameters
Request body
- 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://www.googleapis.com/compute/v1/projects/{project}/global/forwardingRules

The URL uses Google API HTTP annotation 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
{ "resource": { "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, "ipVersion": enum, "kind": string } }

JSON representation

{
  "resource": {
    "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,
    "ipVersion": enum,
    "kind": string
  }
}

Fields
`resource`	`object`
`resource.id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`resource.creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`resource.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.
`resource.description`	`string` An optional description of this resource. Provide this property when you create the resource.
`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.
`resource.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, 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` Authorization requires the following Google IAM permission on the specified resource `ip_address`: `compute.globalAddresses.use`
`resource.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.
`resource.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+)?
`resource.ports[]`	`string` This field is used along with the `backendService` 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. @pattern: [\d+(, \d+)*]
`resource.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. 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`
`resource.selfLink`	`string` [Output Only] Server-defined URL for the resource.
`resource.loadBalancingScheme`	`enum` 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)
`resource.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. Authorization requires the following Google IAM permission on the specified resource `subnetwork`: `compute.subnetworks.use`
`resource.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. Authorization requires the following Google IAM permission on the specified resource `network`: `compute.networks.use`
`resource.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. Authorization requires the following Google IAM permission on the specified resource `backend_service`: `compute.backendServices.use`
`resource.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 a global forwarding rule.
`resource.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
{ "operation": { "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

{
  "operation": {
    "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
`operation`	`object`
`operation.id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`operation.creationTimestamp`	`string` [Deprecated] This field is deprecated.
`operation.name`	`string` [Output Only] Name of the resource.
`operation.zone`	`string` [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`operation.clientOperationId`	`string` [Output Only] Reserved for future use.
`operation.operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`operation.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.
`operation.targetId`	`string (fixed64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`operation.status`	`enum` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`operation.statusMessage`	`string` [Output Only] An optional textual description of the current status of the operation.
`operation.user`	`string` [Output Only] User who requested the operation, for example: `user@example.com`.
`operation.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.
`operation.insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`operation.startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`operation.endTime`	`string` [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`operation.error`	`object` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`operation.error.errors[]`	`object` [Output Only] The array of errors encountered while processing this operation.
`operation.error.errors[].code`	`string` [Output Only] The error type identifier for this error.
`operation.error.errors[].location`	`string` [Output Only] Indicates the field in the request that caused the error. This property is optional.
`operation.error.errors[].message`	`string` [Output Only] An optional, human-readable error message.
`operation.warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`operation.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.
`operation.warnings[].message`	`string` [Output Only] A human-readable description of the warning code.
`operation.warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`operation.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).
`operation.warnings[].data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`operation.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.
`operation.httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`operation.selfLink`	`string` [Output Only] Server-defined URL for the resource.
`operation.region`	`string` [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`operation.description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`operation.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 Auth Guide.

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.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 April 20, 2018.