Подключиться
Yandex Application Load Balancer

Method getTargetStates

Статья создана

Returns the statuses of all targets of the specified backend group in all their availability zones.

HTTP request

GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/loadBalancers/{loadBalancerId}/targetStates/{backendGroupId}/{targetGroupId}

Path parameters

Parameter Description
loadBalancerId

Required. ID of the application load balancer that the backend group is attributed to.
backendGroupId

Required. ID of the backend group that the target group is attributed to.
targetGroupId

Required. ID of the target group to get target states of.

Response

HTTP Code: 200 - OK

{
  "targetStates": [
    {
      "status": {
        "zoneStatuses": [
          {
            "zoneId": "string",
            "status": "string",
            "failedActiveHc": true
          }
        ]
      },
      "target": {
        "subnetId": "string",
        "privateIpv4Address": true,
        "ipAddress": "string"
      }
    }
  ]
}
Field Description
targetStates[] object

Target states of the specified target group.
targetStates[].
status		 object

Health of the target, i.e. its statuses in all availability zones.

Health of the target.
targetStates[].
status.
zoneStatuses[]		 object

Statuses of the target in its availability zones.
targetStates[].
status.
zoneStatuses[].
zoneId		 string

Required. ID of the availability zone.
targetStates[].
status.
zoneStatuses[].
status		 string

Status of the target in the availability zone.

Supported target statuses.

  • HEALTHY: All of the health checks specified in healthchecks or healthchecks are passed (the number depends on the healthyThreshold setting) and the target is ready to receive traffic.
  • PARTIALLY_HEALTHY: Some of the health checks specified in healthchecks or healthchecks failed (the number depends on the unhealthyThreshold setting). The target is ready to receive traffic from the load balancer nodes which, based on their health checks, consider the target healthy.
  • UNHEALTHY: All of the health checks specified in healthchecks or healthchecks failed (the number depends on the unhealthyThreshold setting) and the target is not receiving traffic.
  • DRAINING: Target is being deleted and the application load balancer is no longer sending traffic to this target.
targetStates[].
status.
zoneStatuses[].
failedActiveHc		 boolean (boolean)

Indicates whether the target has been marked UNHEALTHY due to failing active health checks, which determine target statuses as configured in healthchecks or healthchecks.

Currently the only type of health checks is active, as described above. Passive health checks, which determine the health of a target based on its responses to production requests (HTTP 5xx status codes, connection errors etc.), are not implemented yet.
targetStates[].
target		 object

Required. Target.

A target resource. For details about the concept, see documentation.
targetStates[].
target.
subnetId		 string

ID of the subnet that the target is connected to.
targetStates[].
target.
privateIpv4Address		 boolean (boolean)

If set, will not require subnet_id to validate the target. Instead, the address should belong to one of the following ranges: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 Only one of subnet_id or private_ipv4_address should be set.
targetStates[].
target.
ipAddress		 string

IP address of the target.
В этой статье: