Application Load Balancer API, gRPC: BackendGroupService.UpdateBackend

Field

Description

backend_group_id

string

Required field. ID of the backend group to update the backend in.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the backend should be updated.

stream

StreamBackend

New settings for the stream (TCP) backend.

Includes only one of the fields stream, http, grpc.

Name of the backend to update (required) and new settings for the backend.

http

HttpBackend

New settings for the HTTP backend.

Includes only one of the fields stream, http, grpc.

Name of the backend to update (required) and new settings for the backend.

grpc

GrpcBackend

New settings for the gRPC backend.

Includes only one of the fields stream, http, grpc.

Name of the backend to update (required) and new settings for the backend.

Field

Description

name

string

Name of the backend.

Value must match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

backend_weight

google.protobuf.Int64Value

Backend weight. Traffic is distributed between backends of a backend group according to their weights.
Weights must be set either for all backends in a group or for none of them.
Setting no weights is the same as setting equal non-zero weights for all backends.
If the weight is non-positive, traffic is not sent to the backend.

load_balancing_config

LoadBalancingConfig

Load balancing configuration for the backend.

port

int64

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

target_groups

TargetGroupsBackend

Target groups that belong to the backend. For details about target groups, see
documentation.

Includes only one of the fields target_groups.

Reference to targets that belong to the backend.

healthchecks[]

HealthCheck

Health checks to perform on targets from target groups.
For details about health checking, see documentation.
If no health checks are specified, active health checking is not performed.

tls

BackendTls

Settings for TLS connections between load balancer nodes and backend targets.
If specified, the load balancer establishes TLS-encrypted TCP connections with targets and compares received
certificates with the one specified in BackendTls.validation_context.
If not specified, the load balancer establishes unencrypted TCP connections with targets.

enable_proxy_protocol

bool

If set, proxy protocol will be enabled for this backend.

keep_connections_on_host_health_failure

bool

If a backend host becomes unhealthy (as determined by the configured health checks),
keep connections to the failed host.

Field

Description

mode

enum LoadBalancingMode

Load balancing mode for the backend.
For details about load balancing modes, see
documentation.

• ROUND_ROBIN: Round robin load balancing mode.
  All endpoints of the backend take their turns to receive requests attributed to the backend.
• RANDOM: Random load balancing mode. Default value.
  For a request attributed to the backend, an endpoint that receives it is picked at random.
• LEAST_REQUEST: Least request load balancing mode.
  To pick an endpoint that receives a request attributed to the backend, the power of two choices algorithm is used;
  that is, two endpoints are picked at random, and the request is sent to the one which has the fewest active
  requests.
• MAGLEV_HASH: Maglev hashing load balancing mode.
  Each endpoint is hashed, and a hash table with 65537 rows is filled accordingly, so that every endpoint occupies
  the same amount of rows. An attribute of each request is also hashed by the same function (if session affinity is
  enabled for the backend group, the attribute to hash is specified in session affinity configuration). The row
  with the same number as the resulting value is looked up in the table to determine the endpoint that receives
  the request.
  If the backend group with session affinity enabled contains more than one backend with positive weight, endpoints
  for backends with MAGLEV_HASH load balancing mode are picked at RANDOM instead.

panic_threshold

int64

Threshold for panic mode.
If percentage of healthy backends in the group drops below threshold,
panic mode will be activated and traffic will be routed to all backends, regardless of their health check status.
This helps to avoid overloading healthy backends.
For details about panic mode, see documentation.
If the value is 0, panic mode will never be activated and traffic is routed only to healthy backends at all times.
Default value: 0.

Acceptable values are 0 to 100, inclusive.

locality_aware_routing_percent

int64

Percentage of traffic that a load balancer node sends to healthy backends in its availability zone.
The rest is divided equally between other zones. For details about zone-aware routing, see
documentation.
If there are no healthy backends in an availability zone, all the traffic is divided between other zones.
If strict_locality is true, the specified value is ignored.
A load balancer node sends all the traffic within its availability zone, regardless of backends' health.
Default value: 0.

Acceptable values are 0 to 100, inclusive.

strict_locality

bool

Specifies whether a load balancer node should only send traffic to backends in its availability zone,
regardless of their health, and ignore backends in other zones.
If set to true and there are no healthy backends in the zone, the node in this zone will respond
to incoming traffic with errors.
For details about strict locality, see documentation.
If strict_locality is true, the value specified in locality_aware_routing_percent is ignored.
Default value: false.

Field

Description

target_group_ids[]

string

List of ID's of target groups that belong to the backend.
To get the ID's of all available target groups, make a TargetGroupService.List request.

The number of elements must be greater than 0.

Field

Description

timeout

google.protobuf.Duration

Required field. Health check timeout.
The timeout is the time allowed for the target to respond to a check.
If the target doesn't respond in time, the check is considered failed.

interval

google.protobuf.Duration

Required field. Base interval between consecutive health checks.

interval_jitter_percent

double

healthy_threshold

int64

Number of consecutive successful health checks required to mark an unhealthy target as healthy.
Both 0 and 1 values amount to one successful check required.
The value is ignored when a load balancer is initialized; a target is marked healthy after one successful check.
Default value: 0.

unhealthy_threshold

int64

Number of consecutive failed health checks required to mark a healthy target as unhealthy.
Both 0 and 1 values amount to one unsuccessful check required.
The value is ignored if a health check is failed due to an HTTP 503 Service Unavailable response from the target
(not applicable to TCP stream health checks). The target is immediately marked unhealthy.
Default value: 0.

healthcheck_port

int64

Port used for health checks.
If not specified, the backend port (HttpBackend.port or GrpcBackend.port) is used for health checks.

Acceptable values are 0 to 65535, inclusive.

stream

StreamHealthCheck

TCP stream health check settings.

Includes only one of the fields stream, http, grpc.

Protocol-specific health check settings.
The protocols of the backend and of its health check may differ,
e.g. a gRPC health check may be specified for an HTTP backend.

http

HttpHealthCheck

HTTP health check settings.

Includes only one of the fields stream, http, grpc.

Protocol-specific health check settings.
The protocols of the backend and of its health check may differ,
e.g. a gRPC health check may be specified for an HTTP backend.

grpc

GrpcHealthCheck

gRPC health check settings.

Includes only one of the fields stream, http, grpc.

Protocol-specific health check settings.
The protocols of the backend and of its health check may differ,
e.g. a gRPC health check may be specified for an HTTP backend.

plaintext

PlaintextTransportSettings

Includes only one of the fields plaintext, tls.

Optional transport protocol for health checks.
When not set, health checks use the same protocol as the proxied traffic.
Use this when health checks' protocol settings differ from their backend, e.g. plaintext health checks for a TLS backend.

tls

SecureTransportSettings

Includes only one of the fields plaintext, tls.

Optional transport protocol for health checks.
When not set, health checks use the same protocol as the proxied traffic.
Use this when health checks' protocol settings differ from their backend, e.g. plaintext health checks for a TLS backend.

Field

Description

send

Payload

Message sent to targets during TCP data transfer.
If not specified, no data is sent to the target.

receive

Payload

Data that must be contained in the messages received from targets for a successful health check.
If not specified, no messages are expected from targets, and those that are received are not checked.

Field

Description

text

string

Payload text.

The string length in characters must be 1-16384.

Includes only one of the fields text.

Payload.

Field

Description

host

string

Value for the HTTP/1.1 Host header or the HTTP/2 :authority pseudo-header used in requests to targets.

The string length in characters must be 0-255. Value must match the regular expression |[-.a-z0-9]+(:[0-9]+)?.

path

string

HTTP path used in requests to targets: request URI for HTTP/1.1 request line
or value for the HTTP/2 :path pseudo-header.

The string length in characters must be 1-255. Value must match the regular expression /.*.

use_http2

bool

Enables HTTP/2 usage in health checks.
Default value: false, HTTP/1.1 is used.

expected_statuses[]

int64

A list of HTTP response statuses considered healthy.
By default only 200 HTTP status code considered healthy.

Acceptable values are 100 to 599, inclusive.

Field

Description

service_name

string

Name of the gRPC service to be checked.
If not specified, overall health is checked.
For details about the concept, see GRPC Health Checking Protocol.

Field

Description

Empty

Field

Description

sni

string

SNI string for TLS connections.

The maximum string length in characters is 255. Value must match the regular expression [-.a-z0-9]*.

validation_context

ValidationContext

Validation context for backend TLS connections.

Field

Description

trusted_ca_id

string

Includes only one of the fields trusted_ca_id, trusted_ca_bytes.

TLS certificate issued by a trusted certificate authority (CA).

trusted_ca_bytes

string

X.509 certificate contents in PEM format.

Includes only one of the fields trusted_ca_id, trusted_ca_bytes.

TLS certificate issued by a trusted certificate authority (CA).

Field

Description

sni

string

Server Name Indication (SNI) string for TLS connections.

The maximum string length in characters is 255. Value must match the regular expression [-.a-z0-9]*.

validation_context

ValidationContext

Validation context for TLS connections.

Field

Description

name

string

Name of the backend.

Value must match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

backend_weight

google.protobuf.Int64Value

Backend weight. Traffic is distributed between backends of a backend group according to their weights.
Weights must be set either for all backends in a group or for none of them.
Setting no weights is the same as setting equal non-zero weights for all backends.
If the weight is non-positive, traffic is not sent to the backend.

load_balancing_config

LoadBalancingConfig

Load balancing configuration for the backend.

port

int64

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

storage_bucket

StorageBucketBackend

Object Storage bucket to use as the backend. For details about buckets, see
documentation.
If a bucket is used as a backend, the list of bucket objects and the objects themselves must be publicly
accessible. For instructions, see documentation.

Includes only one of the fields storage_bucket, target_groups.

Reference to targets that belong to the backend.
A backend may be a set of target groups or an Object Storage bucket. For details about backend types, see
documentation.

target_groups

TargetGroupsBackend

Target groups that belong to the backend. For details about target groups, see
documentation.

Includes only one of the fields storage_bucket, target_groups.

Reference to targets that belong to the backend.
A backend may be a set of target groups or an Object Storage bucket. For details about backend types, see
documentation.

healthchecks[]

HealthCheck

Health checks to perform on targets from target groups.
For details about health checking, see documentation.
If no health checks are specified, active health checking is not performed.

tls

BackendTls

Settings for TLS connections between load balancer nodes and backend targets.
If specified, the load balancer establishes HTTPS (HTTP over TLS) connections with targets
and compares received certificates with the one specified in BackendTls.validation_context.
If not specified, the load balancer establishes unencrypted HTTP connections with targets.

use_http2

bool

Enables HTTP/2 usage in connections between load balancer nodes and backend targets.
Default value: false, HTTP/1.1 is used.

Field

Description

bucket

string

Required field. Name of the bucket.

Field

Description

name

string

Name of the backend.

Value must match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

backend_weight

google.protobuf.Int64Value

Backend weight. Traffic is distributed between backends of a backend group according to their weights.
Weights must be set either for all backends of a group or for none of them.
Setting no weights is the same as setting equal non-zero weights for all backends.
If the weight is non-positive, traffic is not sent to the backend.

load_balancing_config

LoadBalancingConfig

Load balancing configuration for the backend.

port

int64

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

target_groups

TargetGroupsBackend

Target groups that belong to the backend.

Includes only one of the fields target_groups.

Reference to targets that belong to the backend. For now, targets are referenced via target groups.

healthchecks[]

HealthCheck

Health checks to perform on targets from target groups.
For details about health checking, see documentation.
If no health checks are specified, active health checking is not performed.

tls

BackendTls

Settings for TLS connections between load balancer nodes and backend targets.
If specified, the load balancer establishes HTTPS (HTTP over TLS) connections with targets
and compares received certificates with the one specified in BackendTls.validation_context.
If not specified, the load balancer establishes unencrypted HTTP connections with targets.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.