Table of Contents
The service module contains a set of functions to manipulate the connection
aspect of the request to the Service, such as connecting to a given host, IP
address/port, or choosing a given Upstream entity for load-balancing and
Sets the desired Upstream entity to handle the load-balancing step for
this request. Using this method is equivalent to creating a Service with a
host property equal to that of an Upstream entity (in which case, the
request would be proxied to one of the Targets associated with that
host argument should receive a string equal to that of one of the
Upstream entities currently configured.
true on success, or
nil if no upstream entities
string|nil An error message describing the error if there was
local ok, err = kong.service.set_upstream("service.prod")
if not ok then
Back to TOC
Sets the host and port on which to connect to for proxying the request. ]]
Using this method is equivalent to ask Kong to not run the load-balancing
phase for this request, and consider it manually overridden.
Load-balancing components such as retries and health-checks will also be
ignored for this request.
host argument expects a string containing the IP address of the
upstream server (IPv4/IPv6), and the
port argument must contain a number
representing the port on which to connect to.
- host (string):
- port (number):
Back to TOC