Return status of a stream upstream server group

Returns status of a particular stream upstream server group and its servers.

get/stream/upstreams/{streamUpstreamName}/

Query parameters

fieldsstring

Limits which fields of the upstream server group will be output.

Response

Success

zombiesinteger

The current number of servers removed from the group but still processing active client connections.

zonestring

The name of the shared memory <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</a> that keeps the group’s configuration and run-time state.

Example response

{
  "dns": {
    "peers": [
      {
        "id": 0,
        "server": "10.0.0.1:12347",
        "name": "10.0.0.1:12347",
        "backup": false,
        "weight": 5,
        "state": "up",
        "active": 0,
        "ssl": {
          "handshakes": 200,
          "handshakes_failed": 4,
          "session_reuses": 189,
          "no_common_protocol": 4,
          "handshake_timeout": 0,
          "peer_rejected_cert": 0,
          "verify_failures": {
            "expired_cert": 2,
            "revoked_cert": 1,
            "hostname_mismatch": 2,
            "other": 1
          }
        },
        "max_conns": 50,
        "connections": 667231,
        "sent": 251946292,
        "received": 19222475454,
        "fails": 0,
        "unavail": 0,
        "health_checks": {
          "checks": 26214,
          "fails": 0,
          "unhealthy": 0,
          "last_passed": true
        },
        "downtime": 0,
        "downstart": "2022-06-28T11:09:21.602Z",
        "selected": "2022-06-28T15:01:25Z"
      },
      {
        "id": 1,
        "server": "10.0.0.1:12348",
        "name": "10.0.0.1:12348",
        "backup": true,
        "weight": 1,
        "state": "unhealthy",
        "active": 0,
        "max_conns": 50,
        "connections": 0,
        "sent": 0,
        "received": 0,
        "fails": 0,
        "unavail": 0,
        "health_checks": {
          "checks": 26284,
          "fails": 26284,
          "unhealthy": 1,
          "last_passed": false
        },
        "downtime": 262925617,
        "downstart": "2022-06-28T11:09:21.602Z",
        "selected": "2022-06-28T15:01:25Z"
      }
    ],
    "zombies": 0,
    "zone": "dns"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.