REST Resource: regionBackendServices

string

[Output Only] Type of resource. Always

compute#backendService

for backend services.

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

string

[Output Only] Creation timestamp in RFC3339 text format.

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.

string

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

string

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

object (Backend)

The list of backends that serve this BackendService.

string

The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.

integer

The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.

This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.

Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use

maxStreamDuration

.

integer

Deprecated in favor of

portName

. The TCP port to connect on the backend. The default value is

80

. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit

port

.

enum (Protocol)

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information.

Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.

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.

string

A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit

portName

.

boolean

If

true

, enables Cloud CDN for the backend service of a global external Application Load Balancer.

enum (SessionAffinity)

Type of session affinity to use. The default is

NONE

.

Only

NONE

and

HEADER_FIELD

are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

For more details, see: Session Affinity.

integer

Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity.

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 two weeks (

1,209,600

).

Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

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.

object (FailoverPolicy)

Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

enum (LoadBalancingScheme)

Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.

object (ConnectionDraining)

object (IAP)

The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

object (CdnPolicy)

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

string

Headers that the load balancer adds to proxied requests. See Creating custom headers.

string

Headers that the load balancer adds to proxied responses. See Creating custom headers.

string

[Output Only] The resource URL for the security policy associated with this backend service.

string

[Output Only] The resource URL for the edge security policy associated with this backend service.

object (LogConfig)

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

object (SecuritySettings)

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

enum (LocalityLoadBalancingPolicy)

The load balancing algorithm used within the scope of the locality. The possible values are:

• ROUND_ROBIN

  : This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

• LEAST_REQUEST

  : An

  O(1)

  algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

• RING_HASH

  : The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

• RANDOM

  : The load balancer selects a random healthy host.

• ORIGINAL_DESTINATION

  : Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

• MAGLEV

  : used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824

This field is applicable to either:

• A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
• A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED.

If

sessionAffinity

is not configured—that is, if session affinity remains at the default value of

NONE

—then the default value for

localityLbPolicy

is

ROUND_ROBIN

. If session affinity is set to a value other than

NONE

, then the default value for

localityLbPolicy

is

MAGLEV

.

Only

ROUND_ROBIN

and

RING_HASH

are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

object (ConsistentHashLoadBalancerSettings)

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when

localityLbPolicy

is set to

MAGLEV

or

RING_HASH

.

This field is applicable to either:

• A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
• A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

object (CircuitBreakers)

object (OutlierDetection)

Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled.

Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint.

Applicable backend endpoints can be:

• VM instances in an Instance Group
• Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
• Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
• Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services
• Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect

Applicable backend service types can be:

• A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
• A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs.

Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

string

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to

INTERNAL

.

object (Subsetting)

object (ConnectionTrackingPolicy)

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers.

object (Duration)

Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.

If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.

This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.

This field is only allowed when the

loadBalancingScheme

of the backend service is

INTERNAL_SELF_MANAGED

.

enum (CompressionMode)

Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.

string

URL to

networkservices.ServiceLbPolicy

resource.

Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

string

URLs of

networkservices.ServiceBinding

resources.

Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

object (LocalityLoadBalancingPolicyConfig)

A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field.

For an example of how to use this field, see Define a list of preferred policies.

Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.

enum (IpAddressSelectionPolicy)

Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are:

• IPV4_ONLY

  : Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting.

• PREFER_IPV6

  : Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).

• IPV6_ONLY

  : Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends.

This field is applicable to either:

• Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED),
• Regional external Application Load Balancer,
• Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED),
• Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED),
• Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).

map (key: string, value: string)

Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH

object (UsedBy)

[Output Only] regionBackendServices.list of resources referencing given backend service.

object (HttpCookie)

Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the

sessionAffinity

is set to

STRONG_COOKIE_AFFINITY

.