Network Load Balancer API, REST: NetworkLoadBalancer.GetTargetStates

Written by

Updated at November 26, 2024

Gets states of target resources in the attached target group.

HTTP request

GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}:getTargetStates

Field

Description

networkLoadBalancerId

string

Required field. ID of the NetworkLoadBalancer resource with an attached target group.

Field

Description

targetGroupId

string

ID of the target group to get states of resources from.

HTTP Code: 200 - OK

{
  "targetStates": [
    {
      "subnetId": "string",
      "address": "string",
      "status": "string"
    }
  ]
}

Field

Description

targetStates[]

List of states of targets within the target group that is specified in the GetTargetStatesRequest message.

State of the target that was returned after the last health check.

Field	Description
subnetId	string ID of the subnet that the target is connected to.
address	string IP address of the target.
status	enum (Status) Status of the target. `STATUS_UNSPECIFIED` `INITIAL`: The network load balancer is setting up health checks for this target. `HEALTHY`: Health check passed and the target is ready to receive traffic. `UNHEALTHY`: Health check failed and the target is not receiving traffic. `DRAINING`: Target is being deleted and the network load balancer is no longer sending traffic to this target. `INACTIVE`: The network load balancer is stopped and not performing health checks on this target.