Product Documentation

appqoepolicy

Sep 08, 2016

Statistics for AppQoS policy resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
policyName.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
qosavgserverttfb
<Double>
Read-only
Average Server Time-To-First-Byte in milliseconds calculated for this AppQoE policy.
qosavgserverttfbrate
<Double>
Read-only
Rate (/s) counter for qosavgserverttfb
qosavgserverttlb
<Double>
Read-only
Average Server Time-To-Last-Byte in milliseconds calculated for this AppQoE policy.
qosavgserverttlbrate
<Double>
Read-only
Rate (/s) counter for qosavgserverttlb
qosavgclientttlb
<Double>
Read-only
Average Client Time-To-Last-Byte in milliseconds calculated for this AppQoE policy.
qosavgclientttlbrate
<Double>
Read-only
Rate (/s) counter for qosavgclientttlb
totthroughput
<Double>
Read-only
Throughput in Kbps calculated on this AppQoE policy
throughputrate
<Double>
Read-only
Rate (/s) counter for totthroughput
totsvrlinkedto
<Double>
Read-only
Total number of server connections that were established through this AppQoE Policy
svrlinkedtorate
<Double>
Read-only
Rate (/s) counter for totsvrlinkedto
totcltrequests
<Double>
Read-only
Total number of client connections that were requested through this AppQoE Policy
cltrequestsrate
<Double>
Read-only
Rate (/s) counter for totcltrequests
totrequests
<Double>
Read-only
Total number of requests that were requested through this AppQoE policy
requestsrate
<Double>
Read-only
Rate (/s) counter for totrequests
totrequestbytes
<Double>
Read-only
Total number of requests bytes that were requested through this AppQoE policy
requestbytesrate
<Double>
Read-only
Rate (/s) counter for totrequestbytes
totresponse
<Double>
Read-only
Total number of responses received by this AppQoE policy
responserate
<Double>
Read-only
Rate (/s) counter for totresponse
totresponsebytes
<Double>
Read-only
Total number of response bytes received by this AppQoE policy
responsebytesrate
<Double>
Read-only
Rate (/s) counter for totresponsebytes
totjssent
<Double>
Read-only
Total number of in-memory responses sent instead of expected responses through this AppQoE policy
jssentrate
<Double>
Read-only
Rate (/s) counter for totjssent
totjsbytessent
<Double>
Read-only
Total bytes of in-memory responses sent through this AppQoE policy
jsbytessentrate
<Double>
Read-only
Rate (/s) counter for totjsbytessent
pipolicyhits
<Double>
Read-only
Number of hits on the policy
pipolicyhitsrate
<Double>
Read-only
Rate (/s) counter for pipolicyhits

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

Query-parameters:

args

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

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

{ "appqoepolicy": [ {
      "name":<String_value>,
      "qosavgclientttlbrate":<Double_value>,
      "totjssent":<Double_value>,
      "responsebytesrate":<Double_value>,
      "totthroughput":<Double_value>,
      "requestbytesrate":<Double_value>,
      "totjsbytessent":<Double_value>,
      "svrlinkedtorate":<Double_value>,
      "totresponse":<Double_value>,
      "totresponsebytes":<Double_value>,
      "jssentrate":<Double_value>,
      "qosavgserverttfbrate":<Double_value>,
      "pipolicyhits":<Double_value>,
      "qosavgclientttlb":<Double_value>,
      "totcltrequests":<Double_value>,
      "totrequests":<Double_value>,
      "qosavgserverttlbrate":<Double_value>,
      "totrequestbytes":<Double_value>,
      "cltrequestsrate":<Double_value>,
      "throughputrate":<Double_value>,
      "totsvrlinkedto":<Double_value>,
      "qosavgserverttfb":<Double_value>,
      "pipolicyhitsrate":<Double_value>,
      "jsbytessentrate":<Double_value>,
      "responserate":<Double_value>,
      "requestsrate":<Double_value>,
      "qosavgserverttlb":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/appqoepolicy/name_value><String>

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:

{ "appqoepolicy": [ {
      "name":<String_value>,
      "qosavgclientttlbrate":<Double_value>,
      "totjssent":<Double_value>,
      "responsebytesrate":<Double_value>,
      "totthroughput":<Double_value>,
      "requestbytesrate":<Double_value>,
      "totjsbytessent":<Double_value>,
      "svrlinkedtorate":<Double_value>,
      "totresponse":<Double_value>,
      "totresponsebytes":<Double_value>,
      "jssentrate":<Double_value>,
      "qosavgserverttfbrate":<Double_value>,
      "pipolicyhits":<Double_value>,
      "qosavgclientttlb":<Double_value>,
      "totcltrequests":<Double_value>,
      "totrequests":<Double_value>,
      "qosavgserverttlbrate":<Double_value>,
      "totrequestbytes":<Double_value>,
      "cltrequestsrate":<Double_value>,
      "throughputrate":<Double_value>,
      "totsvrlinkedto":<Double_value>,
      "qosavgserverttfb":<Double_value>,
      "pipolicyhitsrate":<Double_value>,
      "jsbytessentrate":<Double_value>,
      "responserate":<Double_value>,
      "requestsrate":<Double_value>,
      "qosavgserverttlb":<Double_value>
}]}