health

health get

Usage

usage: symp health get

                       [-h] [-f {adaptive_table,json,shell,table,value,yaml}]                          [-c COLUMN] [--max-width <integer>] [--noindent]
                       [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
                       [--extended] [--check-timeout CHECK_TIMEOUT]

Description

Returns the health status.

Note:

This endpoint will be used continuously by cluster manager in order to determine if the service is up and running and ready to serve requests.

Returns

Returns dict: Health status

Optional

optional arguments:
  -h, --help            show this help message and exit
  --extended            If set an extended health check will initiate
  --check-timeout CHECK_TIMEOUT
                        Timeout in seconds for each of the connection tests