Citrix ADC 12.1 NITRO API Reference

appqoe

Statistics for appqoe.

Properties

(click to see Operations)

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.
Possible values = basic, full
totinmemrsp Read-only Total in-memory responses sent from NS
inmemrsprate Read-only Rate (/s) counter for totinmemrsp
totfaultycookies Read-only Total faulty cookies received
faultycookiesrate Read-only Rate (/s) counter for totfaultycookies
totvalidcookies Read-only Total valid cookies received
validcookiesrate Read-only Rate (/s) counter for totvalidcookies
tothighprireq Read-only Total Requests served from higher priority queue
highprireqrate Read-only Rate (/s) counter for tothighprireq
totmediumprireq Read-only Total Requests served from medium priority queue
mediumprireqrate Read-only Rate (/s) counter for totmediumprireq
totlowprireq Read-only Total Requests served from low priority queue
lowprireqrate Read-only Rate (/s) counter for totlowprireq
totlowestprireq Read-only Total Requests served from surge priority queue
lowestprireqrate Read-only Rate (/s) counter for totlowestprireq
totaltsvrsubfailed Read-only Total number of times alternate server substitution failed
tsvrsubfailedrate Read-only Rate (/s) counter for totaltsvrsubfailed
totdostrig Read-only Total number of times HDOS condition triggered
dostrigrate Read-only Rate (/s) counter for totdostrig
totdosqvalidcookies Read-only Total DOSQ valid cookies received
dosqvalidcookiesrate Read-only Rate (/s) counter for totdosqvalidcookies
totdoshvalidcookies Read-only Total DOSH valid cookies received
doshvalidcookiesrate Read-only Rate (/s) counter for totdoshvalidcookies
totsidvalidcookies Read-only Total SID valid cookies received
sidvalidcookiesrate Read-only Rate (/s) counter for totsidvalidcookies
totonhvalidcookies Read-only Total ONH valid cookies received
onhvalidcookiesrate Read-only Rate (/s) counter for totonhvalidcookies
totpriqvalidcookies Read-only Total PRIQ valid cookies received
priqvalidcookiesrate Read-only Rate (/s) counter for totpriqvalidcookies
totdosqfaultycookies Read-only Total DOSQ faulty cookies received
dosqfaultycookiesrate Read-only Rate (/s) counter for totdosqfaultycookies
totdoshfaultycookies Read-only Total DOSH faulty cookies received
doshfaultycookiesrate Read-only Rate (/s) counter for totdoshfaultycookies
totsidfaultycookies Read-only Total SID faulty cookies received
sidfaultycookiesrate Read-only Rate (/s) counter for totsidfaultycookies
totonhfaultycookies Read-only Total ONH faulty cookies received
onhfaultycookiesrate Read-only Rate (/s) counter for totonhfaultycookies
totpriqfaultycookies Read-only Total PRIQ faulty cookies received
priqfaultycookiesrate Read-only Rate (/s) counter for totpriqfaultycookies
totpriembedlinks Read-only Total requests for valid embedded links
priembedlinksrate Read-only Rate (/s) counter for totpriembedlinks
totsessreq Read-only Total valid SIDQ requests within session
sessreqrate Read-only Rate (/s) counter for totsessreq
totaltcntreq Read-only Total requests for alternate contents
tcntreqrate Read-only Rate (/s) counter for totaltcntreq
totgetinmemrsp Read-only Total in-memory GET responses sent from NS
getinmemrsprate Read-only Rate (/s) counter for totgetinmemrsp
totpostinmemrsp Read-only Total in-memory POST responses sent from NS
postinmemrsprate Read-only Rate (/s) counter for totpostinmemrsp
totpostinmemrspbytes Read-only Total in-memory response bytes sent from NS
postinmemrspbytesrate Read-only Rate (/s) counter for totpostinmemrspbytes

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/appqoe

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/appqoe?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get appqoe 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:


{ "appqoe": [ {
"totpriqvalidcookies":<Double_value>,
"totonhvalidcookies":<Double_value>,
"dosqvalidcookiesrate":<Double_value>,
"sidvalidcookiesrate":<Double_value>,
"onhvalidcookiesrate":<Double_value>,
"totdosqvalidcookies":<Double_value>,
"dostrigrate":<Double_value>,
"totgetinmemrsp":<Double_value>,
"totlowprireq":<Double_value>,
"totdoshfaultycookies":<Double_value>,
"doshfaultycookiesrate":<Double_value>,
"sessreqrate":<Double_value>,
"totpostinmemrspbytes":<Double_value>,
"totpriqfaultycookies":<Double_value>,
"totpostinmemrsp":<Double_value>,
"priembedlinksrate":<Double_value>,
"mediumprireqrate":<Double_value>,
"totdostrig":<Double_value>,
"totvalidcookies":<Double_value>,
"totinmemrsp":<Double_value>,
"totsidfaultycookies":<Double_value>,
"totsidvalidcookies":<Double_value>,
"totdosqfaultycookies":<Double_value>,
"tsvrsubfailedrate":<Double_value>,
"postinmemrsprate":<Double_value>,
"totpriembedlinks":<Double_value>,
"totmediumprireq":<Double_value>,
"priqvalidcookiesrate":<Double_value>,
"totfaultycookies":<Double_value>,
"doshvalidcookiesrate":<Double_value>,
"sidfaultycookiesrate":<Double_value>,
"highprireqrate":<Double_value>,
"dosqfaultycookiesrate":<Double_value>,
"inmemrsprate":<Double_value>,
"getinmemrsprate":<Double_value>,
"onhfaultycookiesrate":<Double_value>,
"validcookiesrate":<Double_value>,
"totaltcntreq":<Double_value>,
"totsessreq":<Double_value>,
"priqfaultycookiesrate":<Double_value>,
"tcntreqrate":<Double_value>,
"totdoshvalidcookies":<Double_value>,
"lowprireqrate":<Double_value>,
"tothighprireq":<Double_value>,
"totaltsvrsubfailed":<Double_value>,
"totlowestprireq":<Double_value>,
"lowestprireqrate":<Double_value>,
"totonhfaultycookies":<Double_value>,
"faultycookiesrate":<Double_value>,
"postinmemrspbytesrate":<Double_value>
}]}

<!--NeedCopy-->
appqoe