ADC NITRO APIs

appqoe

Statistics for appqoe.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
totinmemrsp <Double> Read-only Total in-memory responses sent from NS
inmemrsprate <Double> Read-only Rate (/s) counter for totinmemrsp
totfaultycookies <Double> Read-only Total faulty cookies received
faultycookiesrate <Double> Read-only Rate (/s) counter for totfaultycookies
totvalidcookies <Double> Read-only Total valid cookies received
validcookiesrate <Double> Read-only Rate (/s) counter for totvalidcookies
tothighprireq <Double> Read-only Total Requests served from higher priority queue
highprireqrate <Double> Read-only Rate (/s) counter for tothighprireq
totmediumprireq <Double> Read-only Total Requests served from medium priority queue
mediumprireqrate <Double> Read-only Rate (/s) counter for totmediumprireq
totlowprireq <Double> Read-only Total Requests served from low priority queue
lowprireqrate <Double> Read-only Rate (/s) counter for totlowprireq
totlowestprireq <Double> Read-only Total Requests served from surge priority queue
lowestprireqrate <Double> Read-only Rate (/s) counter for totlowestprireq
totaltsvrsubfailed <Double> Read-only Total number of times alternate server substitution failed
tsvrsubfailedrate <Double> Read-only Rate (/s) counter for totaltsvrsubfailed
totdostrig <Double> Read-only Total number of times HDOS condition triggered
dostrigrate <Double> Read-only Rate (/s) counter for totdostrig
totdosqvalidcookies <Double> Read-only Total DOSQ valid cookies received
dosqvalidcookiesrate <Double> Read-only Rate (/s) counter for totdosqvalidcookies
totdoshvalidcookies <Double> Read-only Total DOSH valid cookies received
doshvalidcookiesrate <Double> Read-only Rate (/s) counter for totdoshvalidcookies
totsidvalidcookies <Double> Read-only Total SID valid cookies received
sidvalidcookiesrate <Double> Read-only Rate (/s) counter for totsidvalidcookies
totonhvalidcookies <Double> Read-only Total ONH valid cookies received
onhvalidcookiesrate <Double> Read-only Rate (/s) counter for totonhvalidcookies
totpriqvalidcookies <Double> Read-only Total PRIQ valid cookies received
priqvalidcookiesrate <Double> Read-only Rate (/s) counter for totpriqvalidcookies
totdosqfaultycookies <Double> Read-only Total DOSQ faulty cookies received
dosqfaultycookiesrate <Double> Read-only Rate (/s) counter for totdosqfaultycookies
totdoshfaultycookies <Double> Read-only Total DOSH faulty cookies received
doshfaultycookiesrate <Double> Read-only Rate (/s) counter for totdoshfaultycookies
totsidfaultycookies <Double> Read-only Total SID faulty cookies received
sidfaultycookiesrate <Double> Read-only Rate (/s) counter for totsidfaultycookies
totonhfaultycookies <Double> Read-only Total ONH faulty cookies received
onhfaultycookiesrate <Double> Read-only Rate (/s) counter for totonhfaultycookies
totpriqfaultycookies <Double> Read-only Total PRIQ faulty cookies received
priqfaultycookiesrate <Double> Read-only Rate (/s) counter for totpriqfaultycookies
totpriembedlinks <Double> Read-only Total requests for valid embedded links
priembedlinksrate <Double> Read-only Rate (/s) counter for totpriembedlinks
totsessreq <Double> Read-only Total valid SIDQ requests within session
sessreqrate <Double> Read-only Rate (/s) counter for totsessreq
totaltcntreq <Double> Read-only Total requests for alternate contents
tcntreqrate <Double> Read-only Rate (/s) counter for totaltcntreq
totgetinmemrsp <Double> Read-only Total in-memory GET responses sent from NS
getinmemrsprate <Double> Read-only Rate (/s) counter for totgetinmemrsp
totpostinmemrsp <Double> Read-only Total in-memory POST responses sent from NS
postinmemrsprate <Double> Read-only Rate (/s) counter for totpostinmemrsp
totpostinmemrspbytes <Double> Read-only Total in-memory response bytes sent from NS
postinmemrspbytesrate <Double> 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 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: http:// <netscaler-ip-address> /nitro/v1/stat/appqoe Query-parameters: args http:// <netscaler-ip-address> /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.

attrs http:// <netscaler-ip-address> /nitro/v1/stat/appqoe? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

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 Header:

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