Network Load Balancer API, REST: NetworkLoadBalancer.Get
Returns the specified NetworkLoadBalancer resource.
Get the list of available NetworkLoadBalancer resources by making a List request.
HTTP request
GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}
Path parameters
|
Field |
Description |
|
networkLoadBalancerId |
string Required field. ID of the NetworkLoadBalancer resource to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"regionId": "string",
"status": "string",
"type": "string",
"sessionAffinity": "string",
"listeners": [
{
"name": "string",
"address": "string",
"port": "string",
"protocol": "string",
"targetPort": "string",
"subnetId": "string",
"ipVersion": "string"
}
],
"attachedTargetGroups": [
{
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "string",
"timeout": "string",
"unhealthyThreshold": "string",
"healthyThreshold": "string",
// Includes only one of the fields `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "string"
},
"httpOptions": {
"port": "string",
"path": "string"
}
// end of the list of possible fields
}
]
}
],
"deletionProtection": "boolean",
"allowZonalShift": "boolean"
}
A NetworkLoadBalancer resource. For more information, see Network Load Balancer.
|
Field |
Description |
|
id |
string ID of the network load balancer. |
|
folderId |
string ID of the folder that the network load balancer belongs to. |
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format. 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 |
|
name |
string Name of the network load balancer. The name is unique within the folder. 3-63 characters long. |
|
description |
string Optional description of the network load balancer. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
regionId |
string ID of the region that the network load balancer belongs to. |
|
status |
enum (Status) Status of the network load balancer.
|
|
type |
enum (Type) Type of the network load balancer. Only external network load balancers are available now.
|
|
sessionAffinity |
enum (SessionAffinity) Type of the session affinity. Only 5-tuple affinity is available now.
|
|
listeners[] |
List of listeners for the network load balancer. |
|
attachedTargetGroups[] |
List of target groups attached to the network load balancer. |
|
deletionProtection |
boolean Specifies if network load balancer protected from deletion. |
|
allowZonalShift |
boolean Specifies if network load balancer available to zonal shift. |
Listener
A Listener resource. For more information, see Listener
|
Field |
Description |
|
name |
string Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long. |
|
address |
string IP address for the listener. |
|
port |
string (int64) Port. |
|
protocol |
enum (Protocol) Network protocol for incoming traffic.
|
|
targetPort |
string (int64) Port of a target. |
|
subnetId |
string ID of the subnet. |
|
ipVersion |
enum (IpVersion) IP version of the external address.
|
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
|
Field |
Description |
|
targetGroupId |
string Required field. ID of the target group. |
|
healthChecks[] |
A health check to perform on the target group. |
HealthCheck
A HealthCheck resource. For more information, see Health check.
|
Field |
Description |
|
name |
string Required field. Name of the health check. The name must be unique for each target group that attached to a single load balancer. 3-63 characters long. |
|
interval |
string (duration) The interval between health checks. The default is 2 seconds. |
|
timeout |
string (duration) Timeout for a target to return a response for the health check. The default is 1 second. |
|
unhealthyThreshold |
string (int64) Number of failed health checks before changing the status to |
|
healthyThreshold |
string (int64) Number of successful health checks required in order to set the |
|
tcpOptions |
Options for TCP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
|
httpOptions |
Options for HTTP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
TcpOptions
Configuration option for a TCP health check.
|
Field |
Description |
|
port |
string (int64) Port to use for TCP health checks. |
HttpOptions
Configuration option for an HTTP health check.
|
Field |
Description |
|
port |
string (int64) Port to use for HTTP health checks. |
|
path |
string URL path to set for health checking requests for every target in the target group. |