Download full document:

haproxy_frontend_stats

Configuration for HAProxy frontend stats information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
bin<Double>Read-writeBytes of date in.
hrsp_1xx<Double>Read-writeNo of request with response code 1XX.
bout<Double>Read-writeBytes of data out.
hrsp_other<Double>Read-writeNo of request with other response code.
dresp<Double>Read-writeNo of response denied.
scur<Double>Read-writeCurrent Session.
id<String>Read-writeId is system generated key.
hrsp_2xx<Double>Read-writeNo of request with response code 2XX.
dreq<Double>Read-writeNo of denied requests.
frontend_id<String>Read-writeFrontend ID.
Minimum length = 1
Maximum length = 64
svname<String>Read-writeService Name.
Minimum length = 1
Maximum length = 100
hrsp_4xx<Double>Read-writeNo of request with response code 4XX.
hrsp_3xx<Double>Read-writeNo of request with response code 3XX.
hrsp_5xx<Double>Read-writeNo of request with response code 5XX.
req_rate<Double>Read-onlyHTTP Reqrate/Sec.
ereq<String>Read-onlyNumber of error requests.
req_tot<String>Read-onlyTotal number of requests.
eresp<String>Read-onlyNumber of error responses.
stot<Double>Read-onlyTotal number of sessions.

Operations

(click to see Properties)

GET (ALL)| GET

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/haproxy_frontend_stats

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "haproxy_frontend_stats":[{
"req_rate":<Double_value>,
"bin":<Double_value>,
"hrsp_1xx":<Double_value>,
"bout":<Double_value>,
"hrsp_other":<Double_value>,
"ereq":<String_value>,
"dresp":<Double_value>,
"req_tot":<String_value>,
"scur":<Double_value>,
"id":<String_value>,
"eresp":<String_value>,
"hrsp_2xx":<Double_value>,
"dreq":<Double_value>,
"frontend_id":<String_value>,
"svname":<String_value>,
"hrsp_4xx":<Double_value>,
"hrsp_3xx":<Double_value>,
"stot":<Double_value>,
"hrsp_5xx":<Double_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/haproxy_frontend_stats/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "haproxy_frontend_stats":[{
"req_rate":<Double_value>,
"bin":<Double_value>,
"hrsp_1xx":<Double_value>,
"bout":<Double_value>,
"hrsp_other":<Double_value>,
"ereq":<String_value>,
"dresp":<Double_value>,
"req_tot":<String_value>,
"scur":<Double_value>,
"id":<String_value>,
"eresp":<String_value>,
"hrsp_2xx":<Double_value>,
"dreq":<Double_value>,
"frontend_id":<String_value>,
"svname":<String_value>,
"hrsp_4xx":<Double_value>,
"hrsp_3xx":<Double_value>,
"stot":<Double_value>,
"hrsp_5xx":<Double_value>}]}