Download full document:

pq

Statistics for pq.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
pqtotalpolicymatches<Double>Read-onlyNumber of times the Netscaler appliance matched an incoming request using any priority queuing policy.
pqpolicymatchesrate<Double>Read-onlyRate (/s) counter for pqtotalpolicymatches
pqtotalthresholdfailed<Double>Read-onlyNumber of times the Netscaler appliance failed to match an incoming request to any of priority queing policy.
pqthresholdfailedrate<Double>Read-onlyRate (/s) counter for pqtotalthresholdfailed
pqpriority1requests<Double>Read-onlyNumber of priority 1 requests that the Netscaler appliance received.
pqpriority1requestsrate<Double>Read-onlyRate (/s) counter for pqpriority1requests
pqpriority2requests<Double>Read-onlyNumber of priority 2 requests that the Netscaler appliance received.
pqpriority2requestsrate<Double>Read-onlyRate (/s) counter for pqpriority2requests
pqpriority3requests<Double>Read-onlyNumber of priority 3 requests that the Netscaler appliance received.
pqpriority3requestsrate<Double>Read-onlyRate (/s) counter for pqpriority3requests

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 redand placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

Use this query-parameter to get pq 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "pq": [ {
"pqpriority2requestsrate":<Double_value>,
"pqpolicymatchesrate":<Double_value>,
"pqpriority1requestsrate":<Double_value>,
"pqthresholdfailedrate":<Double_value>,
"pqtotalpolicymatches":<Double_value>,
"pqpriority1requests":<Double_value>,
"pqpriority3requestsrate":<Double_value>,
"pqpriority3requests":<Double_value>,
"pqpriority2requests":<Double_value>,
"pqtotalthresholdfailed":<Double_value>
}]}