Skip to content
Was this article helpful?

haproxy_frontend_stats

Configuration for HAProxy frontend stats information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
bin <Double> Read-write Bytes of date in.
hrsp_1xx <Double> Read-write No of request with response code 1XX.
bout <Double> Read-write Bytes of data out.
hrsp_other <Double> Read-write No of request with other response code.
dresp <Double> Read-write No of response denied.
scur <Double> Read-write Current Session.
id <String> Read-write Id is system generated key.
hrsp_2xx <Double> Read-write No of request with response code 2XX.
dreq <Double> Read-write No of denied requests.
frontend_id <String> Read-write Frontend ID.

Minimum length = 1

Maximum length = 64
svname <String> Read-write Service Name.

Minimum length = 1

Maximum length = 100
hrsp_4xx <Double> Read-write No of request with response code 4XX.
hrsp_3xx <Double> Read-write No of request with response code 3XX.
hrsp_5xx <Double> Read-write No of request with response code 5XX.
req_rate <Double> Read-only HTTP Reqrate/Sec.
ereq <String> Read-only Number of error requests.
req_tot <String> Read-only Total number of requests.
eresp <String> Read-only Number of error responses.
stot <Double> Read-only Total 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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/haproxy_frontend_stats Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/haproxy_frontend_stats ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of haproxy_frontend_stats resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/haproxy_frontend_stats ?pagesize=#no;pageno=#no Use this query-parameter to get the haproxy_frontend_stats resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/haproxy_frontend_stats ?count=yes Use this query-parameter to get the count of haproxy_frontend_stats resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/haproxy_frontend_stats/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}
Was this article helpful?