Create a RestApiHandler instance. + Note

  Currently not different from its superclass link:#patroni.api.RestApiHandler.\\__init\\__[`+\\__init\\__()+`], and only used so `+pyright+` can understand the type of `+server+` attribute.
  +
  Parameters:::
+

Read JSON from HTTP request body. + Note

Retrieves the request body based on content-length HTTP header. The body is expected to be a JSON string with that length.

If request body is expected but content-length HTTP header is absent, then write an HTTP response with HTTP status `+411+`.

  If request body is expected but contains nothing, or if an exception is faced, then write an HTTP response with HTTP status `+400+`.
  +
  Parameters:::
    *body_is_optional* – if `+False+` then the request must contain a body. If `+True+`, then the request may or may not contain a body.
  Returns:::
    deserialized JSON string from request body, if present. If body is absent, but _body_is_optional_ is `+True+`, then return an empty dictionary. Returns `+None+` otherwise.
+

Write an HTTP response with a JSON content type. + Call write_response() with content_type as application/json. +

Write a response that is composed only of the HTTP status. + The response is written with these values separated by space: + __\\__ __\\__ + Note

  This is usually useful for replying to requests from software like HAProxy.
  +
  Parameters:::
    *status_code* – HTTP status code.
  Example:::
+

Write an HTTP response with Patroni/Postgres status in JSON format. + Modifies response before sending it to the client. Defines the patroni key, which is a dictionary that contains the mandatory keys: + __\\__ __\\__ + May also add the following optional keys, depending on the status of this Patroni/PostgreSQL node: + __\\__ __\\__ +

+

+

Process all GET requests which can not be routed to other methods. + Is used for handling all health-checks requests. E.g. “GET /(primary|replica|sync|async|etc…)”. + The (optional) query parameters and the HTTP response status depend on the requested path: + __\\__

Handle a GET request to /cluster path.
Write an HTTP response with JSON content based on the output of cluster_as_json(), with HTTP status 200 and the JSON representation of the cluster topology. +

Handle a GET request to /config path.
Write an HTTP response with a JSON content representing the Patroni configuration that is stored in the DCS, with HTTP status 200.
If the cluster information is not available in the DCS, then it will respond with no body and HTTP status 502 instead. +

Handle a GET request to /failsafe path. + Writes a response with a JSON string body containing all nodes that are known to Patroni at a given point in time, with HTTP status 200. The JSON contains a dictionary, each key is the name of the Patroni node, and the corresponding value is the URI to access /patroni path of its REST API. + Note

  If `+failsafe_mode+` is not enabled, then write a response with HTTP status `+502+`.
+

Handle a GET request to /history path.
Write an HTTP response with a JSON content representing the history of events in the cluster, with HTTP status 200.
The response contains a list of failover/switchover events. Each item is a list with the following items:
__\\__ __\\__ +

Handle a GET request to /liveness path. + Write a simple HTTP response with HTTP status: + __\\__

Handle a GET request to /metrics path.
Write an HTTP response with plain text content in the format used by Prometheus, with HTTP status 200.
The response contains the following items:
__\\__ __\\__
For PostgreSQL v9.6+ the response will also have the following:
__\\__ __\\__ +

Handle a GET request to /patroni path.
Write an HTTP response through _write_status_response(), with HTTP status 200 and the status of Postgres. +

Handle a GET request to /readiness path. + Write a simple HTTP response which HTTP status can be: + __\\__

Handle a HEAD request.
Write a simple HTTP response that represents the current PostgreSQL status. Send only 200+ ``+OK or 503+ ``+Service`+ ``+Unavailable` as a response and nothing more, particularly no headers. +

Handle an OPTIONS request.
Write a simple HTTP response that represents the current PostgreSQL status. Send only 200+ ``+OK or 503+ ``+Service`+ ``+Unavailable` as a response and nothing more, particularly no headers. +

+

+

+

+

Handle a POST request to /mpp path. + Call handle_event() to handle the request, then write a response with HTTP status code 200. + Note

  If unable to parse the request body, then the request is silently discarded.
+

+

+

+

+

Handle a POST request to /switchover path.
Calls do_POST_failover() with switchover option. +

+

Builds an object representing a status of “postgres”. + Some of the values are collected by executing a query and other are taken from the state stored in memory. +

contains the following keys:

Parse and dispatch a request to the appropriate do_* method. + Note

  This is only used to keep track of latency when logging messages through link:#patroni.api.RestApiHandler.log_message[`+log_message()+`].
+

Checks whether there are nodes that could take over after demoting the primary. +

Log a custom debug message. + Additionally, to format, the log entry contains the client IP address and the current latency of the request. +

Override parse_request() to enrich basic functionality of https://docs.python.org/3/library/ http.server.html# http.server.BaseHTTPRequestHandler[BaseHTTPRequestHandler]. + Original class can only invoke do_GET(), do_POST(), do_PUT(), etc method implementations if they are defined. + But we would like to have at least some simple routing mechanism, i.e.: + __\\__ __\\__ + If the do_ method does not exist we’ll fall back to original behavior. +

Parse the given schedule and validate it. +

Poll failover/switchover operation until it finishes or times out. +

Execute sql query with params and optionally return results. +

Write an HTTP response. + Note

Besides `+Content-Type+` header, and the HTTP headers passed through _headers_, this function will also write the HTTP headers defined through `+restapi. http_extra_headers+` and `+restapi. https_extra_headers+` from Patroni configuration.
+
Parameters:::

Check if the system has support for dual stack sockets. +

Start REST API HTTP server. + Note

  If system has no support for dual stack sockets, then IPv4 is preferred over IPv6.
  +
  Parameters:::
+

Establish patroni configuration for the REST API daemon. + Create a RestApiServer instance. +

Configure and start REST API HTTP server. + Note

  This method can be called upon first initialization, and also when reloading Patroni. When reloading Patroni, it restarts the HTTP server thread.
  +
  Parameters:::
  Raises:::
     https://docs.python.org/3/library/exceptions.html#ValueError[`+ValueError+`]: if any issue is faced while parsing _listen_.
+

Resolve each Patroni node restapi.connect_address to IP networks. + Note

  Only yields object if `+restapi.allowlist_include_members+` setting is enabled.
  +
  Yields:::
    each node `+restapi.connect_address+` resolved to an IP network.
+

Resolve host + port to one or more IP networks. +

Resolve each entry in value to an IP network object. +

Set FD_CLOEXEC for fd. + It is used to avoid inheriting the REST API port when forking its process. + Note

  Only takes effect on non-Windows environments.
  +
  Parameters:::
    *fd* – socket file descriptor.
+

Ensure client has enough privileges to perform a given request. + Write a response back to the client if any issue is observed, and the HTTP status may be: + __\\__

Validate HTTP Basic authorization header, if present. +

Check if key matches the password configured for the REST API. +

+

Get serial number of the certificate used by the REST API. +

Handle any exception that is thrown while handling a request to the REST API. + Logs WARNING messages with the client information, and the stack trace of the faced exception. +

Process a request to the REST API. + Wrapper for process_request_thread() that additionally: + __\\__ __\\__ +

Execute sql query with params and optionally return results. + Note

  Prefer to use own connection to postgres and fallback to `+heartbeat+` when own isn’t available.
  +
  Parameters:::
  Returns:::
    a list of rows that were fetched from the database.
  Raises:::
    `+psycopg.Error+`: if had issues while executing _sql_. link:patroni.exceptions.html#patroni.exceptions.PostgresConnectionException[`+PostgresConnectionException+`]: if had issues while connecting to the database.
+

Reload REST API configuration. +

Reload the SSL certificate used by the REST API. +

Shut down a request to the REST API. + Wrapper for + http.server.HTTPServer.shutdown_request()+ that additionally: + __\\__ __\\__ +