Describe target health.

GET

/v1/projects/{projectId}/lb/target-groups/{targetGroupId}/health

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/projects/example/lb/target-groups/example/health \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

Per-target health state reported by the data plane.

Authorizations

• bearerAuth

Parameters

Path Parameters

projectId

required

string

/^p-[a-z0-9-]+$/

targetGroupId

required

string

/^tg-[a-z0-9]+$/

Responses

200

Target health.

Media typeapplication/json

object

items

required

Array<object>

object

targetGroupId

required

string

targetId

required

string

targetType

string

Allowed values: instance network-interface ip auto-scaling-group hostname

ipAddress

The resolved address the load balancer dials. Absent on the synthetic target a POST /targets/actions/register of an auto-scaling-group returns — a group binding has no row of its own; its members appear as ip targets keyed on their instance ids.

string

port

required

integer

weight

integer

enabled

boolean

healthState

required

string

Allowed values: initial healthy unhealthy draining

healthReason

string

nullable

lastHealthCheckAt

string format: date-time

nullable

registeredAt

string format: date-time

instanceId

The owning Stratum instance when this target’s IP resolves to a live NIC in the target group’s VPC; null for external ip targets.

string

nullable

instanceName

The owning instance’s name, resolved alongside instanceId.

string

nullable

nextPageToken

string

Example

{
  "items": [
    {
      "targetType": "instance",
      "healthState": "initial"
    }
  ]
}