Method: backendServices.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 BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

HTTP request

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

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, "selfLink": string, "backends": [ { "description": string, "group": string, "balancingMode": enum, "maxUtilization": number, "maxRate": number, "maxRatePerInstance": number, "maxRatePerEndpoint": number, "maxConnections": number, "maxConnectionsPerInstance": number, "maxConnectionsPerEndpoint": number, "capacityScaler": number } ], "healthChecks": [ string ], "timeoutSec": number, "port": number, "protocol": enum, "fingerprint": string, "portName": string, "enableCDN": boolean, "sessionAffinity": enum, "affinityCookieTtlSec": number, "region": string, "loadBalancingScheme": enum, "connectionDraining": { "drainingTimeoutSec": number }, "iap": { "enabled": boolean, "oauth2ClientId": string, "oauth2ClientSecret": string, "oauth2ClientSecretSha256": string }, "cdnPolicy": { "cacheKeyPolicy": , "signedUrlKeyNames": [ string ], "signedUrlCacheMaxAgeSec": string }, "customRequestHeaders": [ string ], "securityPolicy": string, "kind": string }

JSON representation

{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "backends": [
    {
      "description": string,
      "group": string,
      "balancingMode": enum,
      "maxUtilization": number,
      "maxRate": number,
      "maxRatePerInstance": number,
      "maxRatePerEndpoint": number,
      "maxConnections": number,
      "maxConnectionsPerInstance": number,
      "maxConnectionsPerEndpoint": number,
      "capacityScaler": number
    }
  ],
  "healthChecks": [
    string
  ],
  "timeoutSec": number,
  "port": number,
  "protocol": enum,
  "fingerprint": string,
  "portName": string,
  "enableCDN": boolean,
  "sessionAffinity": enum,
  "affinityCookieTtlSec": number,
  "region": string,
  "loadBalancingScheme": enum,
  "connectionDraining": {
    "drainingTimeoutSec": number
  },
  "iap": {
    "enabled": boolean,
    "oauth2ClientId": string,
    "oauth2ClientSecret": string,
    "oauth2ClientSecretSha256": string
  },
  "cdnPolicy": {
    "cacheKeyPolicy": ,
    "signedUrlKeyNames": [
      string
    ],
    "signedUrlCacheMaxAgeSec": string
  },
  "customRequestHeaders": [
    string
  ],
  "securityPolicy": string,
  "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.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`backends[]`	`object` The list of backends that serve this BackendService.
`backends[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`backends[].group`	`string` The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's `loadBalancingScheme`. When the `loadBalancingScheme` for the backend service is `EXTERNAL`, `INTERNAL_SELF_MANAGED`, or `INTERNAL_MANAGED`, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. When the `loadBalancingScheme` for the backend service is `INTERNAL`, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with `https://www.googleapis.com/`) to specify the instance group or NEG. Partial URLs are not supported. Authorization requires one or more of the following Google IAM permissions on the specified resource `group`: `compute.instanceGroups.use` `compute.networkEndpointGroups.use`
`backends[].balancingMode`	`enum` Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the `loadBalancingScheme`, and `protocol` for the backend service, as well as the type of backend (instance group or NEG). If the load balancing mode is `CONNECTION`, then the load is spread based on how many concurrent connections the backend can handle. The `CONNECTION` balancing mode is only available if the `protocol` for the backend service is `SSL`, `TCP`, or `UDP`. If the `loadBalancingScheme` for the backend service is `EXTERNAL` (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: `maxConnections`, `maxConnectionsPerInstance`, or `maxConnectionsPerEndpoint`. If the `loadBalancingScheme` for the backend service is `INTERNAL` (internal TCP/UDP load balancers), you cannot specify any additional parameters. If the load balancing mode is `RATE`, then the load is spread based on the rate of HTTP requests per second (RPS). The `RATE` balancing mode is only available if the `protocol` for the backend service is `HTTP` or `HTTPS`. You must specify exactly one of the following parameters: `maxRate`, `maxRatePerInstance`, or `maxRatePerEndpoint`. If the load balancing mode is `UTILIZATION`, then the load is spread based on the CPU utilization of instances in an instance group. The `UTILIZATION` balancing mode is only available if the `loadBalancingScheme` of the backend service is `EXTERNAL`, `INTERNAL_SELF_MANAGED`, or `INTERNAL_MANAGED` and the backend is made up of instance groups. There are no restrictions on the backend service protocol.
`backends[].maxUtilization`	`number` Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is `[0.0, 1.0]`. This is an optional parameter if the backend's `balancingMode` is `UTILIZATION`. This parameter can be used in conjunction with `maxRate`, `maxRatePerInstance`, `maxConnections`, or `maxConnectionsPerInstance`.
`backends[].maxRate`	`number` The max requests per second (RPS) of the group. Can be used with either `RATE` or `UTILIZATION` balancing modes, but required if `RATE` mode. For `RATE` mode, either `maxRate` or `maxRatePerInstance` must be set. This cannot be used for internal load balancing.
`backends[].maxRatePerInstance`	`number` Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's `balancingMode` is `UTILIZATION`, this is an optional parameter. If the backend's `balancingMode` is `RATE`, you must specify either this parameter, `maxRate`, or `maxRatePerEndpoint`. Not available if the backend's `balancingMode` is `CONNECTION`.
`backends[].maxRatePerEndpoint`	`number` Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's `balancingMode` is `RATE`, you must specify either this parameter, `maxRate`, or `maxRatePerInstance`. Not available if the backend's `balancingMode` is `CONNECTION`.
`backends[].maxConnections`	`number` Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's `balancingMode` is `UTILIZATION`, this is an optional parameter. If the backend's `balancingMode` is `CONNECTION`, and backend is attached to a backend service whose `loadBalancingScheme` is `EXTERNAL`, you must specify either this parameter, `maxConnectionsPerInstance`, or `maxConnectionsPerEndpoint`. Not available if the backend's `balancingMode` is `RATE`. If the `loadBalancingScheme` is `INTERNAL`, then `maxConnections` is not supported, even though the backend requires a balancing mode of `CONNECTION`.
`backends[].maxConnectionsPerInstance`	`number` Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's `balancingMode` is `UTILIZATION`, this is an optional parameter. If the backend's `balancingMode` is `CONNECTION`, and backend is attached to a backend service whose `loadBalancingScheme` is `EXTERNAL`, you must specify either this parameter, `maxConnections`, or `maxConnectionsPerEndpoint`. Not available if the backend's `balancingMode` is `RATE`. Internal TCP/UDP load balancing does not support setting `maxConnectionsPerInstance` even though its backends require a balancing mode of `CONNECTION`.
`backends[].maxConnectionsPerEndpoint`	`number` Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's `balancingMode` is `CONNECTION`, and the backend is attached to a backend service whose `loadBalancingScheme` is `EXTERNAL`, you must specify either this parameter, `maxConnections`, or `maxConnectionsPerInstance`. Not available if the backend's `balancingMode` is `RATE`. Internal TCP/UDP load balancing does not support setting `maxConnectionsPerEndpoint` even though its backends require a balancing mode of `CONNECTION`.
`backends[].capacityScaler`	`number` A multiplier applied to the group's maximum servicing capacity (based on `UTILIZATION`, `RATE` or `CONNECTION`). Default value is `1`, which means the group will serve up to 100% of its configured capacity (depending on `balancingMode`). A setting of `0` means the group is completely drained, offering 0% of its available Capacity. Valid range is `[0.0,1.0]`. This cannot be used for internal load balancing.
`healthChecks[]`	`string` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. Authorization requires one or more of the following Google IAM permissions on the specified resource `healthChecks`: `compute.healthChecks.useReadOnly` `compute.httpHealthChecks.useReadOnly` `compute.httpsHealthChecks.useReadOnly`
`timeoutSec`	`number` The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.
`port (deprecated)`	`number` Deprecated in favor of `portName`. The TCP port to connect on the backend. The default value is `80`. This cannot be used if the `loadBalancingScheme` is `INTERNAL` (Internal TCP/UDP Load Balancing).
`protocol`	`enum` The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information.
`fingerprint`	`string (bytes format)` 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 BackendService. An up-to-date fingerprint must be provided in order to update the `BackendService`, otherwise the request will fail with error `412 conditionNotMet`. To see the latest fingerprint, make a `get()` request to retrieve a BackendService. A base64-encoded string.
`portName`	`string` A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the `loadBalancingScheme` is `EXTERNAL` and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the `loadBalancingScheme` is `INTERNAL` (Internal TCP/UDP Load Blaancing).
`enableCDN`	`boolean` If `true`, enables Cloud CDN for the backend service. Only applicable if the `loadBalancingScheme` is `EXTERNAL` and the `protocol` is `HTTP` or `HTTPS`.
`sessionAffinity`	`enum` Type of session affinity to use. The default is `NONE`. Session affinity is not applicable if the --protocol is UDP. When the `loadBalancingScheme` is `EXTERNAL`, possible values are `NONE`, `CLIENT_IP`, or `GENERATED_COOKIE`. `GENERATED_COOKIE` is only available if the `protocol` is `HTTP` or `HTTPS`. When the `loadBalancingScheme` is `INTERNAL`, possible values are `NONE`, `CLIENT_IP`, `CLIENT_IP_PROTO`, or `CLIENT_IP_PORT_PROTO`. When the `loadBalancingScheme` is `INTERNAL_SELF_MANAGED`, possible values are `NONE`, `CLIENT_IP`, `GENERATED_COOKIE`, `HEADER_FIELD`, or `HTTP_COOKIE`.
`affinityCookieTtlSec`	`number` If set to `0`, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (`86,400`).
`region`	`string` [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`loadBalancingScheme`	`enum` Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are `INTERNAL` and `EXTERNAL`.
`connectionDraining`	`object`
`connectionDraining.drainingTimeoutSec`	`number` The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the `protocol` is not `UDP`. The valid range is `[0, 3600]`.
`iap`	`object`
`iap.enabled`	`boolean`
`iap.oauth2ClientId`	`string`
`iap.oauth2ClientSecret`	`string`
`iap.oauth2ClientSecretSha256`	`string` [Output Only] SHA256 hash value for the field oauth2ClientSecret above.
`cdnPolicy`	`object` Cloud CDN configuration for this BackendService.
`cdnPolicy.cacheKeyPolicy`	`object` The CacheKeyPolicy for this CdnPolicy.
`cdnPolicy.cacheKeyPolicy.includeProtocol`	`boolean` If true, http and https requests will be cached separately.
`cdnPolicy.cacheKeyPolicy.includeHost`	`boolean` If true, requests to different hosts will be cached separately.
`cdnPolicy.cacheKeyPolicy.includeQueryString`	`boolean` If true, include query string parameters in the cache key according to queryStringWhitelist and queryStringBlacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
`cdnPolicy.cacheKeyPolicy.queryStringWhitelist[]`	`string` Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
`cdnPolicy.cacheKeyPolicy.queryStringBlacklist[]`	`string` Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
`cdnPolicy.signedUrlKeyNames[]`	`string` [Output Only] Names of the keys for signing request URLs.
`cdnPolicy.signedUrlCacheMaxAgeSec`	`string (int64 format)` Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a `"Cache-Control: public, max-age=[TTL]"` header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
`customRequestHeaders[]`	`string` Headers that the HTTP/S load balancer should add to proxied requests.
`securityPolicy`	`string` [Output Only] The resource URL for the security policy associated with this backend service.
`kind`	`string` [Output Only] Type of resource. Always `compute#backendService` for backend services.

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 resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the resource.
`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.backendServices.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 June 18, 2019.