load-balancer

Get load balancer member metrics series

Returns backend member metric series by given {service-uuid}, {backend-name}, and {member-name}.

get/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members/{member-name}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members/{member-name}
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The UUID of the service.

Example:01234567-89ab-cdef-0123-456789abcdef

The unique identifier for the service.

backend-namestring required

The name of the backend.

Example:backend-infra

The unique identifier for the backend.

member-namestring required

The name of the member.

Example:dev-member

The unique identifier for the member.

Query parameters

sort'start_at' | '-start_at'

Sort metrics by field. Prefix with '-' for descending order.

Example:start_at

Response

Created

start_atstring date-time required

Timestamp marking the start of the metrics collection period.

end_atstring date-time required

Timestamp marking the end of the metrics collection period.

membersstring[] required

List of backend member identifiers included in the metrics series.

request_bytesinteger

Total number of request bytes processed by all members in the series.

response_bytesinteger

Total number of response bytes sent by all members.

denied_responsesinteger

Total number of denied responses returned during the period.

http_responses_1xxinteger

Count of HTTP 1xx informational responses.

http_responses_2xxinteger

Count of HTTP 2xx successful responses.

http_responses_3xxinteger

Count of HTTP 3xx redirection responses.

http_responses_4xxinteger

Count of HTTP 4xx client error responses.

http_responses_5xxinteger

Count of HTTP 5xx server error responses.

http_responses_otherinteger

Count of HTTP responses outside the 1xx–5xx range.

sessionsinteger

Total number of active or completed sessions during the metrics window.

downtimeinteger

Total downtime duration in seconds.

failed_checks_transitionsinteger

Number of transitions from healthy to failed health checks detected during the period.

client_abortedinteger

Number of connections aborted by the client.

failed_connectionsinteger

Number of backend connection attempts that failed.

invalid_responsesinteger

Number of invalid or malformed responses detected.

routed_requestsinteger

Total number of requests successfully routed to the backend members.

server_abortedinteger

Number of connections aborted by the backend server.

server_redispatchesinteger

Number of requests redispatched to another backend member after an initial failure.

server_connection_retriesinteger

Number of backend connection retry attempts.

failed_checksinteger

Total number of failed health checks for all members combined.

Example response

{
  "start_at": "2025-11-06T09:00:00.000Z",
  "end_at": "2025-11-06T10:00:00.000Z",
  "members": [
    "backend-member-1",
    "backend-member-2"
  ],
  "request_bytes": 12345678,
  "response_bytes": 11876543,
  "denied_responses": 12,
  "http_responses_1xx": 2,
  "http_responses_2xx": 9500,
  "http_responses_3xx": 35,
  "http_responses_4xx": 18,
  "http_responses_5xx": 6,
  "http_responses_other": 0,
  "sessions": 220,
  "downtime": 45,
  "failed_checks_transitions": 3,
  "client_aborted": 7,
  "failed_connections": 2,
  "invalid_responses": 1,
  "routed_requests": 10234,
  "server_aborted": 4,
  "server_redispatches": 5,
  "server_connection_retries": 9,
  "failed_checks": 15
}

Changes

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