Stream Upstreams
Method GET

Return status of all stream upstream server groups

Returns status of each stream upstream server group and its servers.

get/stream/upstreams/

Query parameters

fieldsstring

Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.

Response

Success

NginxStreamUpstreamMap required

Status information of stream upstream server groups.

Example response

{
  "mysql_backends": {
    "peers": [
      {
        "id": 0,
        "server": "10.0.0.1:12345",
        "name": "10.0.0.1:12345",
        "backup": false,
        "weight": 5,
        "state": "up",
        "active": 0,
        "ssl": {
          "handshakes": 1045,
          "handshakes_failed": 89,
          "session_reuses": 321,
          "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": 30,
        "connecions": 1231,
        "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:12346",
        "name": "10.0.0.1:12346",
        "backup": true,
        "weight": 1,
        "state": "unhealthy",
        "active": 0,
        "max_conns": 30,
        "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": "mysql_backends"
  },
  "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": 5268,
          "handshakes_failed": 121,
          "session_reuses": 854,
          "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": 30,
        "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,
        "connections": 0,
        "max_conns": 30,
        "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.