Method list

A backend group resource. For details about the concept, see documentation.

ID of the backend group. Generated at creation time.

Name of the backend group. The name is unique within the folder. The string length in characters is 3-63.

Description of the backend group. The string is 0-256 characters long.

ID of the folder that the backend group belongs to.

Backend group labels as key:value pairs. For details about the concept, see documentation. The maximum number of labels is 64.

Creation timestamp.

String in RFC3339 text format.

An HTTP backend group resource.

An HTTP backend resource.

Required. Name of the backend.

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

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.

A load balancing configuration resource.

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.

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

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 localityAwareRoutingPercent is ignored.

Default value: false.

Load balancing mode for the backend.

For details about load balancing modes, see documentation.

A load balancing mode resource. For details about the concept, 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.

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

A health check resource. For details about the concept, see documentation.

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

Required. Base interval between consecutive health checks.

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.

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.

Port used for health checks.

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

Acceptable values are 0 to 65535, inclusive.

A resource for TCP stream health check settings.

Message sent to targets during TCP data transfer.

If not specified, no data is sent to the target.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

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.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

A resource for HTTP health check settings.

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

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

Enables HTTP/2 usage in health checks.

Default value: false, HTTP/1.1 is used.

A resource for gRPC health check settings.

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.

Transport settings to be used instead of the settings configured per-cluster

Transport settings to be used instead of the settings configured per-cluster

SNI string for TLS connections.

Validation context for backend TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

A resource for backend TLS settings.

Server Name Indication (SNI) string for TLS connections.

Validation context for TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

Enables HTTP/2 usage in connections between load balancer nodes and backend targets.

Default value: false, HTTP/1.1 is used.

A resource for target groups that belong to the backend.

Required. List of ID's of target groups that belong to the backend.

To get the ID's of all available target groups, make a list request.

Must contain at least one element.

A resource for Object Storage bucket used as a backend. For details about the concept, see documentation.

Required. Name of the bucket.

A resource for connection-based session affinity configuration.

Specifies whether an IP address of the client is used to define a connection for session affinity.

A resource for HTTP-header-field-based session affinity configuration.

Name of the HTTP header field that is used for session affinity.

The string length in characters must be 1-256.

A resource for cookie-based session affinity configuration.

Name of the cookie that is used for session affinity.

The string length in characters must be 1-256.

Maximum age of cookies that are generated for sessions.

If set to 0, session cookies are used, which are stored by clients in temporary memory and are deleted on client restarts.

If not set, the balancer does not generate cookies and only uses incoming ones for establishing session affinity.

A gRPC backend group resource.

A gRPC backend resource.

Required. Name of the backend.

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

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.

A load balancing configuration resource.

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.

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

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 localityAwareRoutingPercent is ignored.

Default value: false.

Load balancing mode for the backend.

For details about load balancing modes, see documentation.

A load balancing mode resource. For details about the concept, 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.

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

A health check resource. For details about the concept, see documentation.

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

Required. Base interval between consecutive health checks.

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.

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.

Port used for health checks.

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

Acceptable values are 0 to 65535, inclusive.

A resource for TCP stream health check settings.

Message sent to targets during TCP data transfer.

If not specified, no data is sent to the target.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

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.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

A resource for HTTP health check settings.

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

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

Enables HTTP/2 usage in health checks.

Default value: false, HTTP/1.1 is used.

A resource for gRPC health check settings.

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.

Transport settings to be used instead of the settings configured per-cluster

Transport settings to be used instead of the settings configured per-cluster

SNI string for TLS connections.

Validation context for backend TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

A resource for backend TLS settings.

Server Name Indication (SNI) string for TLS connections.

Validation context for TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

A resource for target groups that belong to the backend.

Required. List of ID's of target groups that belong to the backend.

To get the ID's of all available target groups, make a list request.

Must contain at least one element.

A resource for connection-based session affinity configuration.

Specifies whether an IP address of the client is used to define a connection for session affinity.

A resource for HTTP-header-field-based session affinity configuration.

Name of the HTTP header field that is used for session affinity.

The string length in characters must be 1-256.

A resource for cookie-based session affinity configuration.

Name of the cookie that is used for session affinity.

The string length in characters must be 1-256.

Maximum age of cookies that are generated for sessions.

If set to 0, session cookies are used, which are stored by clients in temporary memory and are deleted on client restarts.

If not set, the balancer does not generate cookies and only uses incoming ones for establishing session affinity.

A stream (TCP) backend group resource.

A stream (TCP) backend resource.

Name of the backend.

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

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.

A load balancing configuration resource.

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.

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

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 localityAwareRoutingPercent is ignored.

Default value: false.

Load balancing mode for the backend.

For details about load balancing modes, see documentation.

A load balancing mode resource. For details about the concept, 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.

Port used by all targets to receive traffic.

Acceptable values are 0 to 65535, inclusive.

A health check resource. For details about the concept, see documentation.

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

Required. Base interval between consecutive health checks.

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.

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.

Port used for health checks.

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

Acceptable values are 0 to 65535, inclusive.

A resource for TCP stream health check settings.

Message sent to targets during TCP data transfer.

If not specified, no data is sent to the target.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

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.

A health check payload resource.

Payload text.

The string length in characters must be greater than 0.

A resource for HTTP health check settings.

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

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

Enables HTTP/2 usage in health checks.

Default value: false, HTTP/1.1 is used.

A resource for gRPC health check settings.

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.

Transport settings to be used instead of the settings configured per-cluster

Transport settings to be used instead of the settings configured per-cluster

SNI string for TLS connections.

Validation context for backend TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

A resource for backend TLS settings.

Server Name Indication (SNI) string for TLS connections.

Validation context for TLS connections.

A TLS validation context resource.

X.509 certificate contents in PEM format.

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

A resource for target groups that belong to the backend.

Required. List of ID's of target groups that belong to the backend.

To get the ID's of all available target groups, make a list request.

Must contain at least one element.

A resource for connection-based session affinity configuration.

Specifies whether an IP address of the client is used to define a connection for session affinity.

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use next_page_token as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.