Method 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
| Parameter | Description |
|---|---|
| networkLoadBalancerId | ID of the NetworkLoadBalancer resource to return. To get the network load balancer ID, use a list request. The maximum string length in characters is 50. |
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",
// `attachedTargetGroups[].healthChecks[]` includes only one of the fields `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "string"
},
"httpOptions": {
"port": "string",
"path": "string"
},
// end of the list of possible fields`attachedTargetGroups[].healthChecks[]`
}
]
}
]
}
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. |
| 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 Resource labels as |
| regionId | string ID of the region that the network load balancer belongs to. |
| status | string Status of the network load balancer.
|
| type | string Type of the network load balancer. Only external network load balancers are available now. Type of the load balancer. Only external load balancers are currently available.
|
| sessionAffinity | string Type of the session affinity. Only 5-tuple affinity is available now. Type of session affinity. Only 5-tuple affinity is currently available. For more information, see Load Balancer concepts.
|
| listeners[] | object A Listener resource. For more information, see Listener |
| listeners[]. name |
string Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long. |
| listeners[]. address |
string IP address for the listener. |
| listeners[]. port |
string (int64) Port. |
| listeners[]. protocol |
string Network protocol for incoming traffic. Network protocol to use. |
| listeners[]. targetPort |
string (int64) Port of a target. |
| listeners[]. subnetId |
string ID of the subnet. |
| listeners[]. ipVersion |
string IP version of the external address. IP version of the addresses that the load balancer works with. Only IPv4 is currently available.
|
| attachedTargetGroups[] | object An AttachedTargetGroup resource. For more information, see Targets and groups. |
| attachedTargetGroups[]. targetGroupId |
string Required. ID of the target group. The maximum string length in characters is 50. |
| attachedTargetGroups[]. healthChecks[] |
object A HealthCheck resource. For more information, see Health check. |
| attachedTargetGroups[]. healthChecks[]. name |
string Required. 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. Value must match the regular expression |
| attachedTargetGroups[]. healthChecks[]. interval |
string The interval between health checks. The default is 2 seconds. |
| attachedTargetGroups[]. healthChecks[]. timeout |
string Timeout for a target to return a response for the health check. The default is 1 second. |
| attachedTargetGroups[]. healthChecks[]. unhealthyThreshold |
string (int64) Number of failed health checks before changing the status to Acceptable values are 2 to 10, inclusive. |
| attachedTargetGroups[]. healthChecks[]. healthyThreshold |
string (int64) Number of successful health checks required in order to set the Acceptable values are 2 to 10, inclusive. |
| attachedTargetGroups[]. healthChecks[]. tcpOptions |
object Options for TCP health check. attachedTargetGroups[].healthChecks[] includes only one of the fields tcpOptions, httpOptionsConfiguration option for a TCP health check. |
| attachedTargetGroups[]. healthChecks[]. tcpOptions. port |
string (int64) Port to use for TCP health checks. Acceptable values are 1 to 65535, inclusive. |
| attachedTargetGroups[]. healthChecks[]. httpOptions |
object Options for HTTP health check. attachedTargetGroups[].healthChecks[] includes only one of the fields tcpOptions, httpOptionsConfiguration option for an HTTP health check. |
| attachedTargetGroups[]. healthChecks[]. httpOptions. port |
string (int64) Port to use for HTTP health checks. Acceptable values are 1 to 65535, inclusive. |
| attachedTargetGroups[]. healthChecks[]. httpOptions. path |
string URL path to set for health checking requests for every target in the target group. For example |