Application Load Balancer API, REST: BackendGroup.get
Returns the specified backend group.
To get the list of all available backend groups, make a list request.
HTTP request
GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/backendGroups/{backendGroupId}
Path parameters
Parameter | Description |
---|---|
backendGroupId | Required. ID of the backend group to return. To get the backend group ID, make a list request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"name": "string",
"description": "string",
"folderId": "string",
"labels": "object",
"createdAt": "string",
// includes only one of the fields `http`, `grpc`, `stream`
"http": {
"backends": [
{
"name": "string",
"backendWeight": "integer",
"loadBalancingConfig": {
"panicThreshold": "string",
"localityAwareRoutingPercent": "string",
"strictLocality": true,
"mode": "string"
},
"port": "string",
"healthchecks": [
{
"timeout": "string",
"interval": "string",
"intervalJitterPercent": "number",
"healthyThreshold": "string",
"unhealthyThreshold": "string",
"healthcheckPort": "string",
// `http.backends[].healthchecks[]` includes only one of the fields `plaintext`, `tls`
"stream": {
"send": {
"text": "string"
},
"receive": {
"text": "string"
}
},
"http": {
"host": "string",
"path": "string",
"useHttp2": true
},
"grpc": {
"serviceName": "string"
},
// end of the list of possible fields`http.backends[].healthchecks[]`
"plaintext": {},
"tls": {
"sni": "string",
"validationContext": {
// `http.backends[].healthchecks[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`http.backends[].healthchecks[].tls.validationContext`
}
}
}
],
"tls": {
"sni": "string",
"validationContext": {
// `http.backends[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`http.backends[].tls.validationContext`
}
},
"useHttp2": true,
// `http.backends[]` includes only one of the fields `targetGroups`, `storageBucket`
"targetGroups": {
"targetGroupIds": [
"string"
]
},
"storageBucket": {
"bucket": "string"
},
// end of the list of possible fields`http.backends[]`
}
],
// `http` includes only one of the fields `connection`, `header`, `cookie`
"connection": {
"sourceIp": true
},
"header": {
"headerName": "string"
},
"cookie": {
"name": "string",
"ttl": "string"
},
// end of the list of possible fields`http`
},
"grpc": {
"backends": [
{
"name": "string",
"backendWeight": "integer",
"loadBalancingConfig": {
"panicThreshold": "string",
"localityAwareRoutingPercent": "string",
"strictLocality": true,
"mode": "string"
},
"port": "string",
"healthchecks": [
{
"timeout": "string",
"interval": "string",
"intervalJitterPercent": "number",
"healthyThreshold": "string",
"unhealthyThreshold": "string",
"healthcheckPort": "string",
// `grpc.backends[].healthchecks[]` includes only one of the fields `plaintext`, `tls`
"stream": {
"send": {
"text": "string"
},
"receive": {
"text": "string"
}
},
"http": {
"host": "string",
"path": "string",
"useHttp2": true
},
"grpc": {
"serviceName": "string"
},
// end of the list of possible fields`grpc.backends[].healthchecks[]`
"plaintext": {},
"tls": {
"sni": "string",
"validationContext": {
// `grpc.backends[].healthchecks[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`grpc.backends[].healthchecks[].tls.validationContext`
}
}
}
],
"tls": {
"sni": "string",
"validationContext": {
// `grpc.backends[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`grpc.backends[].tls.validationContext`
}
},
"targetGroups": {
"targetGroupIds": [
"string"
]
}
}
],
// `grpc` includes only one of the fields `connection`, `header`, `cookie`
"connection": {
"sourceIp": true
},
"header": {
"headerName": "string"
},
"cookie": {
"name": "string",
"ttl": "string"
},
// end of the list of possible fields`grpc`
},
"stream": {
"backends": [
{
"name": "string",
"backendWeight": "integer",
"loadBalancingConfig": {
"panicThreshold": "string",
"localityAwareRoutingPercent": "string",
"strictLocality": true,
"mode": "string"
},
"port": "string",
"healthchecks": [
{
"timeout": "string",
"interval": "string",
"intervalJitterPercent": "number",
"healthyThreshold": "string",
"unhealthyThreshold": "string",
"healthcheckPort": "string",
// `stream.backends[].healthchecks[]` includes only one of the fields `plaintext`, `tls`
"stream": {
"send": {
"text": "string"
},
"receive": {
"text": "string"
}
},
"http": {
"host": "string",
"path": "string",
"useHttp2": true
},
"grpc": {
"serviceName": "string"
},
// end of the list of possible fields`stream.backends[].healthchecks[]`
"plaintext": {},
"tls": {
"sni": "string",
"validationContext": {
// `stream.backends[].healthchecks[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`stream.backends[].healthchecks[].tls.validationContext`
}
}
}
],
"tls": {
"sni": "string",
"validationContext": {
// `stream.backends[].tls.validationContext` includes only one of the fields `trustedCaId`, `trustedCaBytes`
"trustedCaId": "string",
"trustedCaBytes": "string",
// end of the list of possible fields`stream.backends[].tls.validationContext`
}
},
"enableProxyProtocol": true,
"targetGroups": {
"targetGroupIds": [
"string"
]
}
}
],
"connection": {
"sourceIp": true
}
},
// end of the list of possible fields
}
A backend group resource.
For details about the concept, see documentation.
Field | Description |
---|---|
id | string ID of the backend group. Generated at creation time. |
name | string Name of the backend group. The name is unique within the folder. The string length in characters is 3-63. |
description | string Description of the backend group. The string is 0-256 characters long. |
folderId | string ID of the folder that the backend group belongs to. |
labels | object Backend group labels as |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
http | object List of HTTP backends that the backend group consists of. includes only one of the fields http , grpc , stream |
http. backends[] |
object HTTP backend to add to the backend group. |
http. backends[]. name |
string Required. Name of the backend. Value must match the regular expression |
http. backends[]. backendWeight |
integer (int64) 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. |
http. backends[]. loadBalancingConfig |
object Load balancing configuration for the backend. |
http. backends[]. loadBalancingConfig. panicThreshold |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
http. backends[]. loadBalancingConfig. localityAwareRoutingPercent |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
http. backends[]. loadBalancingConfig. strictLocality |
boolean (boolean) 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 If Default value: |
http. backends[]. loadBalancingConfig. mode |
string 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.
|
http. backends[]. port |
string (int64) Port used by all targets to receive traffic. Acceptable values are 0 to 65535, inclusive. |
http. backends[]. healthchecks[] |
object 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. |
http. backends[]. healthchecks[]. timeout |
string 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. |
http. backends[]. healthchecks[]. interval |
string Required. Base interval between consecutive health checks. |
http. backends[]. healthchecks[]. intervalJitterPercent |
number (double) |
http. backends[]. healthchecks[]. healthyThreshold |
string (int64) Number of consecutive successful health checks required to mark an unhealthy target as healthy. Both The value is ignored when a load balancer is initialized; a target is marked healthy after one successful check. Default value: |
http. backends[]. healthchecks[]. unhealthyThreshold |
string (int64) Number of consecutive failed health checks required to mark a healthy target as unhealthy. Both The value is ignored if a health check is failed due to an HTTP Default value: |
http. backends[]. healthchecks[]. healthcheckPort |
string (int64) Port used for health checks. If not specified, the backend port ( Acceptable values are 0 to 65535, inclusive. |
http. backends[]. healthchecks[]. stream |
object TCP stream health check settings. http.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
http. backends[]. healthchecks[]. stream. send |
object Message sent to targets during TCP data transfer. If not specified, no data is sent to the target. A health check payload resource. |
http. backends[]. healthchecks[]. stream. send. text |
string Payload text. The string length in characters must be greater than 0. |
http. backends[]. healthchecks[]. stream. receive |
object 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. |
http. backends[]. healthchecks[]. stream. receive. text |
string Payload text. The string length in characters must be greater than 0. |
http. backends[]. healthchecks[]. http |
object HTTP health check settings. http.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
http. backends[]. healthchecks[]. http. host |
string Value for the HTTP/1.1 |
http. backends[]. healthchecks[]. http. path |
string Required. HTTP path used in requests to targets: request URI for HTTP/1.1 request line or value for the HTTP/2 |
http. backends[]. healthchecks[]. http. useHttp2 |
boolean (boolean) Enables HTTP/2 usage in health checks. Default value: |
http. backends[]. healthchecks[]. grpc |
object gRPC health check settings. http.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
http. backends[]. healthchecks[]. grpc. serviceName |
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. |
http. backends[]. healthchecks[]. plaintext |
object http.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
http. backends[]. healthchecks[]. tls |
object http.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
http. backends[]. healthchecks[]. tls. sni |
string SNI string for TLS connections. |
http. backends[]. healthchecks[]. tls. validationContext |
object Validation context for backend TLS connections. A TLS validation context resource. |
http. backends[]. healthchecks[]. tls. validationContext. trustedCaId |
string http.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
http. backends[]. healthchecks[]. tls. validationContext. trustedCaBytes |
string http.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
http. backends[]. tls |
object 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 validationContext . If not specified, the load balancer establishes unencrypted HTTP connections with targets. |
http. backends[]. tls. sni |
string Server Name Indication (SNI) string for TLS connections. |
http. backends[]. tls. validationContext |
object Validation context for TLS connections. A TLS validation context resource. |
http. backends[]. tls. validationContext. trustedCaId |
string http.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
http. backends[]. tls. validationContext. trustedCaBytes |
string http.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
http. backends[]. useHttp2 |
boolean (boolean) Enables HTTP/2 usage in connections between load balancer nodes and backend targets. Default value: |
http. backends[]. targetGroups |
object Target groups that belong to the backend. For details about target groups, see documentation. http.backends[] includes only one of the fields targetGroups , storageBucket |
http. backends[]. targetGroups. targetGroupIds[] |
string 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. |
http. backends[]. storageBucket |
object 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. http.backends[] includes only one of the fields targetGroups , storageBucket |
http. backends[]. storageBucket. bucket |
string Required. Name of the bucket. |
http. connection |
object Connection-based session affinity configuration. For now, a connection is defined only by an IP address of the client. http includes only one of the fields connection , header , cookie |
http. connection. sourceIp |
boolean (boolean) Specifies whether an IP address of the client is used to define a connection for session affinity. |
http. header |
object HTTP-header-field-based session affinity configuration. http includes only one of the fields connection , header , cookie |
http. header. headerName |
string Name of the HTTP header field that is used for session affinity. The string length in characters must be 1-256. |
http. cookie |
object Cookie-based session affinity configuration. http includes only one of the fields connection , header , cookie |
http. cookie. name |
string Name of the cookie that is used for session affinity. The string length in characters must be 1-256. |
http. cookie. ttl |
string Maximum age of cookies that are generated for sessions. If set to If not set, the balancer does not generate cookies and only uses incoming ones for establishing session affinity. |
grpc | object List of gRPC backends that the backend group consists of. includes only one of the fields http , grpc , stream |
grpc. backends[] |
object gRPC backend to add to the backend group. |
grpc. backends[]. name |
string Required. Name of the backend. Value must match the regular expression |
grpc. backends[]. backendWeight |
integer (int64) 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. |
grpc. backends[]. loadBalancingConfig |
object Load balancing configuration for the backend. |
grpc. backends[]. loadBalancingConfig. panicThreshold |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
grpc. backends[]. loadBalancingConfig. localityAwareRoutingPercent |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
grpc. backends[]. loadBalancingConfig. strictLocality |
boolean (boolean) 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 If Default value: |
grpc. backends[]. loadBalancingConfig. mode |
string 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.
|
grpc. backends[]. port |
string (int64) Port used by all targets to receive traffic. Acceptable values are 0 to 65535, inclusive. |
grpc. backends[]. healthchecks[] |
object 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. |
grpc. backends[]. healthchecks[]. timeout |
string 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. |
grpc. backends[]. healthchecks[]. interval |
string Required. Base interval between consecutive health checks. |
grpc. backends[]. healthchecks[]. intervalJitterPercent |
number (double) |
grpc. backends[]. healthchecks[]. healthyThreshold |
string (int64) Number of consecutive successful health checks required to mark an unhealthy target as healthy. Both The value is ignored when a load balancer is initialized; a target is marked healthy after one successful check. Default value: |
grpc. backends[]. healthchecks[]. unhealthyThreshold |
string (int64) Number of consecutive failed health checks required to mark a healthy target as unhealthy. Both The value is ignored if a health check is failed due to an HTTP Default value: |
grpc. backends[]. healthchecks[]. healthcheckPort |
string (int64) Port used for health checks. If not specified, the backend port ( Acceptable values are 0 to 65535, inclusive. |
grpc. backends[]. healthchecks[]. stream |
object TCP stream health check settings. grpc.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
grpc. backends[]. healthchecks[]. stream. send |
object Message sent to targets during TCP data transfer. If not specified, no data is sent to the target. A health check payload resource. |
grpc. backends[]. healthchecks[]. stream. send. text |
string Payload text. The string length in characters must be greater than 0. |
grpc. backends[]. healthchecks[]. stream. receive |
object 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. |
grpc. backends[]. healthchecks[]. stream. receive. text |
string Payload text. The string length in characters must be greater than 0. |
grpc. backends[]. healthchecks[]. http |
object HTTP health check settings. grpc.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
grpc. backends[]. healthchecks[]. http. host |
string Value for the HTTP/1.1 |
grpc. backends[]. healthchecks[]. http. path |
string Required. HTTP path used in requests to targets: request URI for HTTP/1.1 request line or value for the HTTP/2 |
grpc. backends[]. healthchecks[]. http. useHttp2 |
boolean (boolean) Enables HTTP/2 usage in health checks. Default value: |
grpc. backends[]. healthchecks[]. grpc |
object gRPC health check settings. grpc.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
grpc. backends[]. healthchecks[]. grpc. serviceName |
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. |
grpc. backends[]. healthchecks[]. plaintext |
object grpc.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
grpc. backends[]. healthchecks[]. tls |
object grpc.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
grpc. backends[]. healthchecks[]. tls. sni |
string SNI string for TLS connections. |
grpc. backends[]. healthchecks[]. tls. validationContext |
object Validation context for backend TLS connections. A TLS validation context resource. |
grpc. backends[]. healthchecks[]. tls. validationContext. trustedCaId |
string grpc.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
grpc. backends[]. healthchecks[]. tls. validationContext. trustedCaBytes |
string grpc.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
grpc. backends[]. tls |
object 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 validationContext . If not specified, the load balancer establishes unencrypted HTTP connections with targets. |
grpc. backends[]. tls. sni |
string Server Name Indication (SNI) string for TLS connections. |
grpc. backends[]. tls. validationContext |
object Validation context for TLS connections. A TLS validation context resource. |
grpc. backends[]. tls. validationContext. trustedCaId |
string grpc.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
grpc. backends[]. tls. validationContext. trustedCaBytes |
string grpc.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
grpc. backends[]. targetGroups |
object Target groups that belong to the backend. |
grpc. backends[]. targetGroups. targetGroupIds[] |
string 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. |
grpc. connection |
object Connection-based session affinity configuration. For now, a connection is defined only by an IP address of the client. grpc includes only one of the fields connection , header , cookie |
grpc. connection. sourceIp |
boolean (boolean) Specifies whether an IP address of the client is used to define a connection for session affinity. |
grpc. header |
object HTTP-header-field-based session affinity configuration. grpc includes only one of the fields connection , header , cookie |
grpc. header. headerName |
string Name of the HTTP header field that is used for session affinity. The string length in characters must be 1-256. |
grpc. cookie |
object Cookie-based session affinity configuration. grpc includes only one of the fields connection , header , cookie |
grpc. cookie. name |
string Name of the cookie that is used for session affinity. The string length in characters must be 1-256. |
grpc. cookie. ttl |
string Maximum age of cookies that are generated for sessions. If set to If not set, the balancer does not generate cookies and only uses incoming ones for establishing session affinity. |
stream | object List of stream (TCP) backends that the backend group consists of. includes only one of the fields http , grpc , stream |
stream. backends[] |
object New settings for the Stream backend. |
stream. backends[]. name |
string Name of the backend. Value must match the regular expression |
stream. backends[]. backendWeight |
integer (int64) 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. |
stream. backends[]. loadBalancingConfig |
object Load balancing configuration for the backend. |
stream. backends[]. loadBalancingConfig. panicThreshold |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
stream. backends[]. loadBalancingConfig. localityAwareRoutingPercent |
string (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 Default value: Acceptable values are 0 to 100, inclusive. |
stream. backends[]. loadBalancingConfig. strictLocality |
boolean (boolean) 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 If Default value: |
stream. backends[]. loadBalancingConfig. mode |
string 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.
|
stream. backends[]. port |
string (int64) Port used by all targets to receive traffic. Acceptable values are 0 to 65535, inclusive. |
stream. backends[]. healthchecks[] |
object 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. |
stream. backends[]. healthchecks[]. timeout |
string 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. |
stream. backends[]. healthchecks[]. interval |
string Required. Base interval between consecutive health checks. |
stream. backends[]. healthchecks[]. intervalJitterPercent |
number (double) |
stream. backends[]. healthchecks[]. healthyThreshold |
string (int64) Number of consecutive successful health checks required to mark an unhealthy target as healthy. Both The value is ignored when a load balancer is initialized; a target is marked healthy after one successful check. Default value: |
stream. backends[]. healthchecks[]. unhealthyThreshold |
string (int64) Number of consecutive failed health checks required to mark a healthy target as unhealthy. Both The value is ignored if a health check is failed due to an HTTP Default value: |
stream. backends[]. healthchecks[]. healthcheckPort |
string (int64) Port used for health checks. If not specified, the backend port ( Acceptable values are 0 to 65535, inclusive. |
stream. backends[]. healthchecks[]. stream |
object TCP stream health check settings. stream.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
stream. backends[]. healthchecks[]. stream. send |
object Message sent to targets during TCP data transfer. If not specified, no data is sent to the target. A health check payload resource. |
stream. backends[]. healthchecks[]. stream. send. text |
string Payload text. The string length in characters must be greater than 0. |
stream. backends[]. healthchecks[]. stream. receive |
object 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. |
stream. backends[]. healthchecks[]. stream. receive. text |
string Payload text. The string length in characters must be greater than 0. |
stream. backends[]. healthchecks[]. http |
object HTTP health check settings. stream.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
stream. backends[]. healthchecks[]. http. host |
string Value for the HTTP/1.1 |
stream. backends[]. healthchecks[]. http. path |
string Required. HTTP path used in requests to targets: request URI for HTTP/1.1 request line or value for the HTTP/2 |
stream. backends[]. healthchecks[]. http. useHttp2 |
boolean (boolean) Enables HTTP/2 usage in health checks. Default value: |
stream. backends[]. healthchecks[]. grpc |
object gRPC health check settings. stream.backends[].healthchecks[] includes only one of the fields stream , http , grpc |
stream. backends[]. healthchecks[]. grpc. serviceName |
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. |
stream. backends[]. healthchecks[]. plaintext |
object stream.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
stream. backends[]. healthchecks[]. tls |
object stream.backends[].healthchecks[] includes only one of the fields plaintext , tls Transport settings to be used instead of the settings configured per-cluster |
stream. backends[]. healthchecks[]. tls. sni |
string SNI string for TLS connections. |
stream. backends[]. healthchecks[]. tls. validationContext |
object Validation context for backend TLS connections. A TLS validation context resource. |
stream. backends[]. healthchecks[]. tls. validationContext. trustedCaId |
string stream.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
stream. backends[]. healthchecks[]. tls. validationContext. trustedCaBytes |
string stream.backends[].healthchecks[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
stream. backends[]. tls |
object 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 validationContext . If not specified, the load balancer establishes unencrypted TCP connections with targets. |
stream. backends[]. tls. sni |
string Server Name Indication (SNI) string for TLS connections. |
stream. backends[]. tls. validationContext |
object Validation context for TLS connections. A TLS validation context resource. |
stream. backends[]. tls. validationContext. trustedCaId |
string stream.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes |
stream. backends[]. tls. validationContext. trustedCaBytes |
string stream.backends[].tls.validationContext includes only one of the fields trustedCaId , trustedCaBytes X.509 certificate contents in PEM format. |
stream. backends[]. enableProxyProtocol |
boolean (boolean) If set, proxy protocol will be enabled for this backend. |
stream. backends[]. targetGroups |
object Target groups that belong to the backend. For details about target groups, see documentation. |
stream. backends[]. targetGroups. targetGroupIds[] |
string 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. |
stream. connection |
object Connection-based session affinity configuration. For now, a connection is defined only by an IP address of the client. |
stream. connection. sourceIp |
boolean (boolean) Specifies whether an IP address of the client is used to define a connection for session affinity. |