Citrix ADC 12.1 NITRO API Reference

protocolhttp

August 17, 2023

Contributed by:

Statistics for HTTP resource.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
spdytotstreams	Read-only	Total number of requests received over SPDYv2 and SPDYv3
spdystreamsrate	Read-only	Rate (/s) counter for spdytotstreams
httptotrequests	Read-only	Total number of HTTP requests received.
httprequestsrate	Read-only	Rate (/s) counter for httptotrequests
httptotresponses	Read-only	Total number of HTTP responses sent.
httpresponsesrate	Read-only	Rate (/s) counter for httptotresponses
httptotrxrequestbytes	Read-only	Total number of bytes of HTTP request data received.
httprxrequestbytesrate	Read-only	Rate (/s) counter for httptotrxrequestbytes
httptotrxresponsebytes	Read-only	Total number of bytes of HTTP response data received.
httprxresponsebytesrate	Read-only	Rate (/s) counter for httptotrxresponsebytes
httptotgets	Read-only	Total number of HTTP requests received with the GET method.
httpgetsrate	Read-only	Rate (/s) counter for httptotgets
httptotposts	Read-only	Total number of HTTP requests received with the POST method.
httppostsrate	Read-only	Rate (/s) counter for httptotposts
httptotothers	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	Read-only	Rate (/s) counter for httptotothers
httptot10requests	Read-only	Total number of HTTP/1.0 requests received.
http10requestsrate	Read-only	Rate (/s) counter for httptot10requests
httptot11requests	Read-only	Total number of HTTP/1.1 requests received.
http11requestsrate	Read-only	Rate (/s) counter for httptot11requests
httptotclenrequests	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	Read-only	Rate (/s) counter for httptotclenrequests
httptotchunkedrequests	Read-only	Total number of HTTP requests in which the Transfer-Encoding field of the HTTP header has been set to chunked.
httpchunkedrequestsrate	Read-only	Rate (/s) counter for httptotchunkedrequests
httptottxrequestbytes	Read-only	Total number of bytes of HTTP request data transmitted.
httptxrequestbytesrate	Read-only	Rate (/s) counter for httptottxrequestbytes
httptot10responses	Read-only	Total number of HTTP/1.0 responses sent.
http10responsesrate	Read-only	Rate (/s) counter for httptot10responses
httptot11responses	Read-only	Total number of HTTP/1.1 responses sent.
http11responsesrate	Read-only	Rate (/s) counter for httptot11responses
httptotclenresponses	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	Read-only	Rate (/s) counter for httptotclenresponses
httptotchunkedresponses	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	Read-only	Rate (/s) counter for httptotchunkedresponses
httperrnoreusemultipart	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	Read-only	Rate (/s) counter for httperrnoreusemultipart
httptotnoclenchunkresponses	Read-only	Total number of FIN-terminated responses sent. In FIN-terminated responses, the server finishes sending the data and closes the connection.
httpnoclenchunkresponsesrate	Read-only	Rate (/s) counter for httptotnoclenchunkresponses
httptottxresponsebytes	Read-only	Total number of bytes of HTTP response data transmitted.
httptxresponsebytesrate	Read-only	Rate (/s) counter for httptottxresponsebytes
httperrincompleteheaders	Read-only	Total number of HTTP requests and responses received in which the HTTP header spans more than one packet.
httperrincompleterequests	Read-only	Total number of HTTP requests received in which the header spans more than one packet.
httperrincompleterequestsrate	Read-only	Rate (/s) counter for httperrincompleterequests
httperrincompleteresponses	Read-only	Total number of HTTP responses received in which the header spans more than one packet.
httperrincompleteresponsesrate	Read-only	Rate (/s) counter for httperrincompleteresponses
httperrserverbusy	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	Read-only	Rate (/s) counter for httperrserverbusy
httperrlargecontent	Read-only	Total number of requests and responses received with large body.
httperrlargechunk	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	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	Read-only	Total number of requests received over SPDYv2
spdyv2streamsrate	Read-only	Rate (/s) counter for spdyv2totstreams
spdyv3totstreams	Read-only	Total number of requests received over SPDYv3
spdyv3streamsrate	Read-only	Rate (/s) counter for spdyv3totstreams

Operations

(click to see Properties)

GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/protocolhttp

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

protocolhttp

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

protocolhttp

Properties

Operations

get (all)

In this article