Method: regionBackendServices.update

Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

HTTP request

PUT https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region scoping this request.

resourceId

string

Name of the BackendService resource to update.

Query 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).

Request body

The request body contains data with the following structure:

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "selfLink": string,
    "backends": ,
    "healthChecks": string,
    "timeoutSec": number,
    "port": number,
    "protocol": enum,
    "fingerprint": string,
    "portName": string,
    "enableCDN": boolean,
    "sessionAffinity": enum,
    "affinityCookieTtlSec": number,
    "region": string,
    "loadBalancingScheme": enum,
    "connectionDraining": ,
    "iap": ,
    "cdnPolicy": ,
    "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.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.backends[]

object

The list of backends that serve this BackendService.

resource.backends[].description

string

An optional description of this resource. Provide this property when you create the resource.

resource.backends[].group

string

The fully-qualified URL of a Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.

When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService.

resource.backends[].balancingMode

enum

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

For Internal Load Balancing, the default and only supported mode is CONNECTION.

resource.backends[].maxUtilization

number

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].

This cannot be used for internal load balancing.

resource.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.

resource.backends[].maxRatePerInstance

number

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

resource.backends[].maxConnections

number

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

resource.backends[].maxConnectionsPerInstance

number

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

resource.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.

resource.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.

resource.timeoutSec

number

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.

resource.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 for internal load balancing.

resource.protocol

enum

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

resource.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.

A base64-encoded string.

resource.portName

string

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

When the load balancing scheme is INTERNAL, this field is not used.

resource.enableCDN

boolean

If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.

resource.sessionAffinity

enum

Type of session affinity to use. The default is NONE.

When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.

When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the protocol is UDP, this field is not used.

resource.affinityCookieTtlSec

number

Lifetime of cookies in seconds if sessionAffinity is GENERATED_COOKIE. 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 for TTL is one day.

When the load balancing scheme is INTERNAL, this field is not used.

resource.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.

resource.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.

resource.connectionDraining

object

resource.connectionDraining.drainingTimeoutSec

number

Time for which instance will be drained (not accept new connections, but still work to finish started).

resource.iap

object

resource.iap.enabled

boolean

resource.iap.oauth2ClientId

string

resource.iap.oauth2ClientSecret

string

resource.iap.oauth2ClientSecretSha256

string

[Output Only] SHA256 hash value for the field oauth2ClientSecret above.

resource.cdnPolicy

object

Cloud CDN configuration for this BackendService.

resource.cdnPolicy.cacheKeyPolicy

object

The CacheKeyPolicy for this CdnPolicy.

resource.cdnPolicy.cacheKeyPolicy.includeProtocol

boolean

If true, http and https requests will be cached separately.

resource.cdnPolicy.cacheKeyPolicy.includeHost

boolean

If true, requests to different hosts will be cached separately.

resource.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.

resource.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.

resource.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.

resource.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
{
  "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.

Send feedback about...

Compute Engine