Product Documentation

protocolhttp

Sep 08, 2016

Statistics for HTTP resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
spdytotstreams
<Double>
Read-only
Total number of requests received over SPDYv2 and SPDYv3
spdystreamsrate
<Double>
Read-only
Rate (/s) counter for spdytotstreams
httptotrequests
<Double>
Read-only
Total number of HTTP requests received.
httprequestsrate
<Double>
Read-only
Rate (/s) counter for httptotrequests
httptotresponses
<Double>
Read-only
Total number of HTTP responses sent.
httpresponsesrate
<Double>
Read-only
Rate (/s) counter for httptotresponses
httptotrxrequestbytes
<Double>
Read-only
Total number of bytes of HTTP request data received.
httprxrequestbytesrate
<Double>
Read-only
Rate (/s) counter for httptotrxrequestbytes
httptotrxresponsebytes
<Double>
Read-only
Total number of bytes of HTTP response data received.
httprxresponsebytesrate
<Double>
Read-only
Rate (/s) counter for httptotrxresponsebytes
httptotgets
<Double>
Read-only
Total number of HTTP requests received with the GET method.
httpgetsrate
<Double>
Read-only
Rate (/s) counter for httptotgets
httptotposts
<Double>
Read-only
Total number of HTTP requests received with the POST method.
httppostsrate
<Double>
Read-only
Rate (/s) counter for httptotposts
httptotothers
<Double>
Read-only
Total number of HTTP requests received with methods other than GET and POST. Some of the other well-defined HTTP methods are HEAD, PUT, DELETE, OPTIONS, and TRACE. User-defined methods are also allowed.
httptohersrate
<Double>
Read-only
Rate (/s) counter for httptotothers
httptot10requests
<Double>
Read-only
Total number of HTTP/1.0 requests received.
http10requestsrate
<Double>
Read-only
Rate (/s) counter for httptot10requests
httptot11requests
<Double>
Read-only
Total number of HTTP/1.1 requests received.
http11requestsrate
<Double>
Read-only
Rate (/s) counter for httptot11requests
httptotclenrequests
<Double>
Read-only
Total number of HTTP requests in which the Content-length field of the HTTP header has been set. Content-length specifies the length of the content, in bytes, in the associated HTTP body.
httpclenrequestsrate
<Double>
Read-only
Rate (/s) counter for httptotclenrequests
httptotchunkedrequests
<Double>
Read-only
Total number of HTTP requests in which the Transfer-Encoding field of the HTTP header has been set to chunked.
httpchunkedrequestsrate
<Double>
Read-only
Rate (/s) counter for httptotchunkedrequests
httptottxrequestbytes
<Double>
Read-only
Total number of bytes of HTTP request data transmitted.
httptxrequestbytesrate
<Double>
Read-only
Rate (/s) counter for httptottxrequestbytes
httptot10responses
<Double>
Read-only
Total number of HTTP/1.0 responses sent.
http10responsesrate
<Double>
Read-only
Rate (/s) counter for httptot10responses
httptot11responses
<Double>
Read-only
Total number of HTTP/1.1 responses sent.
http11responsesrate
<Double>
Read-only
Rate (/s) counter for httptot11responses
httptotclenresponses
<Double>
Read-only
Total number of HTTP responses sent in which the Content-length field of the HTTP header has been set. Content-length specifies the length of the content, in bytes, in the associated HTTP body.
httpclenresponsesrate
<Double>
Read-only
Rate (/s) counter for httptotclenresponses
httptotchunkedresponses
<Double>
Read-only
Total number of HTTP responses sent in which the Transfer-Encoding field of the HTTP header has been set to chunked. This setting is used when the server wants to start sending the response before knowing its total length. The server breaks the response into chunks and sends them in sequence, inserting the length of each chunk before the actual data. The message ends with a chunk of size zero.
httpchunkedresponsesrate
<Double>
Read-only
Rate (/s) counter for httptotchunkedresponses
httperrnoreusemultipart
<Double>
Read-only
Total number of HTTP multi-part responses sent. In multi-part responses, one or more entities are encapsulated within the body of a single message.
httperrnoreusemultipartrate
<Double>
Read-only
Rate (/s) counter for httperrnoreusemultipart
httptotnoclenchunkresponses
<Double>
Read-only
Total number of FIN-terminated responses sent. In FIN-terminated responses, the server finishes sending the data and closes the connection.
httpnoclenchunkresponsesrate
<Double>
Read-only
Rate (/s) counter for httptotnoclenchunkresponses
httptottxresponsebytes
<Double>
Read-only
Total number of bytes of HTTP response data transmitted.
httptxresponsebytesrate
<Double>
Read-only
Rate (/s) counter for httptottxresponsebytes
httperrincompleteheaders
<Double>
Read-only
Total number of HTTP requests and responses received in which the HTTP header spans more than one packet.
httperrincompleterequests
<Double>
Read-only
Total number of HTTP requests received in which the header spans more than one packet.
httperrincompleterequestsrate
<Double>
Read-only
Rate (/s) counter for httperrincompleterequests
httperrincompleteresponses
<Double>
Read-only
Total number of HTTP responses received in which the header spans more than one packet.
httperrincompleteresponsesrate
<Double>
Read-only
Rate (/s) counter for httperrincompleteresponses
httperrserverbusy
<Double>
Read-only
Total number of HTTP error responses received. Some of the error responses are: 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout 505 HTTP Version Not Supported
httperrserverbusyrate
<Double>
Read-only
Rate (/s) counter for httperrserverbusy
httperrlargecontent
<Double>
Read-only
Total number of requests and responses received with large body.
httperrlargechunk
<Double>
Read-only
Total number of requests received with large chunk size, in which the Transfer-Encoding field of the HTTP header has been set to chunked.
httperrlargectlen
<Double>
Read-only
Total number of requests received with large content, in which the Content-length field of the HTTP header has been set. Content-length specifies the length of the content, in bytes, in the associated HTTP body.
spdyv2totstreams
<Double>
Read-only
Total number of requests received over SPDYv2
spdyv2streamsrate
<Double>
Read-only
Rate (/s) counter for spdyv2totstreams
spdyv3totstreams
<Double>
Read-only
Total number of requests received over SPDYv3
spdyv3streamsrate
<Double>
Read-only
Rate (/s) counter for spdyv3totstreams

Operations (click to see Properties)

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>

메모

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/protocolhttp

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/protocolhttp?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get protocolhttp resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "protocolhttp": [ {
      "httptotclenresponses":<Double_value>,
      "httperrnoreusemultipart":<Double_value>,
      "spdyv3streamsrate":<Double_value>,
      "httprxrequestbytesrate":<Double_value>,
      "httptotrxresponsebytes":<Double_value>,
      "httptotchunkedresponses":<Double_value>,
      "httperrincompleterequests":<Double_value>,
      "httptot10requests":<Double_value>,
      "httptotgets":<Double_value>,
      "httperrlargecontent":<Double_value>,
      "http10responsesrate":<Double_value>,
      "httperrserverbusy":<Double_value>,
      "httptxrequestbytesrate":<Double_value>,
      "httptotposts":<Double_value>,
      "httptotclenrequests":<Double_value>,
      "httprxresponsebytesrate":<Double_value>,
      "spdyv2streamsrate":<Double_value>,
      "httperrincompleteresponsesrate":<Double_value>,
      "httpnoclenchunkresponsesrate":<Double_value>,
      "httpchunkedrequestsrate":<Double_value>,
      "http11responsesrate":<Double_value>,
      "httptotrequests":<Double_value>,
      "httptotresponses":<Double_value>,
      "httperrincompleteresponses":<Double_value>,
      "spdytotstreams":<Double_value>,
      "httptottxrequestbytes":<Double_value>,
      "httperrserverbusyrate":<Double_value>,
      "http11requestsrate":<Double_value>,
      "spdystreamsrate":<Double_value>,
      "httptxresponsebytesrate":<Double_value>,
      "httptohersrate":<Double_value>,
      "httpchunkedresponsesrate":<Double_value>,
      "httptot11responses":<Double_value>,
      "http10requestsrate":<Double_value>,
      "httprequestsrate":<Double_value>,
      "httpresponsesrate":<Double_value>,
      "httptot10responses":<Double_value>,
      "httptotnoclenchunkresponses":<Double_value>,
      "httperrlargechunk":<Double_value>,
      "httperrnoreusemultipartrate":<Double_value>,
      "spdyv3totstreams":<Double_value>,
      "httperrincompleteheaders":<Double_value>,
      "httptot11requests":<Double_value>,
      "httppostsrate":<Double_value>,
      "httpgetsrate":<Double_value>,
      "httpclenresponsesrate":<Double_value>,
      "httperrlargectlen":<Double_value>,
      "httptottxresponsebytes":<Double_value>,
      "spdyv2totstreams":<Double_value>,
      "httptotchunkedrequests":<Double_value>,
      "httperrincompleterequestsrate":<Double_value>,
      "httpclenrequestsrate":<Double_value>,
      "httptotrxrequestbytes":<Double_value>,
      "httptotothers":<Double_value>
}]}