load-balancer

Get load balancer backend metrics series

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

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

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-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.

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.

backendsstring[] required

List of backend identifiers included in the metrics series.

request_bytesinteger

Total number of request bytes processed.

response_bytesinteger

Total number of response bytes sent.

denied_responsesinteger

Total number of denied responses.

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 sessions.

downtimeinteger

Total downtime in seconds.

failed_checks_transitionsinteger

Number of transitions from healthy to failed health checks.

client_abortedinteger

Number of client-aborted connections.

failed_connectionsinteger

Number of failed connections.

invalid_responsesinteger

Number of invalid responses.

routed_requestsinteger

Number of routed requests.

server_abortedinteger

Number of server-aborted connections.

server_redispatchesinteger

Number of server redispatches.

server_connection_retriesinteger

Number of server connection retries.

Example response

[]

Changes

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