Download full document:

protocolhttpband

Configuration for HTTP request/response band resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
reqbandsize<Integer>Read-writeBand size, in bytes, for HTTP request band statistics. For example, if you specify a band size of 100 bytes, statistics will be maintained and displayed for the following size ranges:<br>0 - 99 bytes<br>100 - 199 bytes<br>200 - 299 bytes and so on.<br>Default value: 100<br>Minimum value = 50
respbandsize<Integer>Read-writeBand size, in bytes, for HTTP response band statistics. For example, if you specify a band size of 100 bytes, statistics will be maintained and displayed for the following size ranges:<br>0 - 99 bytes<br>100 - 199 bytes<br>200 - 299 bytes and so on.<br>Default value: 1024<br>Minimum value = 50
type<String>Read-writeType of statistics to display.<br>Possible values = REQUEST, RESPONSE
nodeid<Double>Read-writeUnique number that identifies the cluster node.<br>Minimum value = 0<br>Maximum value = 31
bandrange<Integer>Read-onlyThe range of the HTTP request/response size, in bytes.
numberofbands<Integer>Read-onlyThe total number of http bands.
totalbandsize<Double[]>Read-onlyThe total size of all HTTP requests/responses in this size range.
avgbandsize<Double[]>Read-onlyThe average size of all HTTP requests/responses in this size range.
avgbandsizenew<Double[]>Read-onlyThe average size of all HTTP requests/responses in this size range.
banddata<Double[]>Read-onlyThe total size of all HTTP requests/responses in this size range, expressed as a percentage of the total size of all HTTP requests/responses.
banddatanew<Double[]>Read-onlyThe total size of all HTTP requests/responses in this size range, expressed as a percentage of the total size of all HTTP requests/responses.
accesscount<Double[]>Read-onlyThe number of HTTP requests/responses in this size range.
accessratio<Double[]>Read-onlyThe number of HTTP requests/responses in this size range, expressed as a percentage of the total number of HTTP requests/responses.
accessrationew<Double[]>Read-onlyThe number of HTTP requests/responses in this size range, expressed as a percentage of the total number of HTTP requests/responses.
totals<Integer[]>Read-onlyThe total of totalBandSize, avgBandSize, BandData, accessCount, accessRatio respectively.

Operations

(click to see Properties)

UPDATE | UNSET | CLEAR | 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>.

update

URL: http://<netscaler-ip-address>/nitro/v1/config/protocolhttpband

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 

{"protocolhttpband":{
      "reqbandsize":<Integer_value>,
      "respbandsize":<Integer_value>
}}

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

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/protocolhttpband?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 

{"protocolhttpband":{
      "reqbandsize":true,
      "respbandsize":true
}}

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

clear

URL: http://<netscaler-ip-address>/nitro/v1/config/protocolhttpband?action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 

{"protocolhttpband":{
      "type":<String_value>
}}

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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/protocolhttpband

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/protocolhttpband?args=type:<String_value>,nodeid:<Double_value>

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

{ "protocolhttpband": [ {
type:<String_value>,nodeid:<Double_value>      "bandrange":<Integer_value>,
      "numberofbands":<Integer_value>,
      "totalbandsize":<Double[]_value>,
      "avgbandsize":<Double[]_value>,
      "avgbandsizenew":<Double[]_value>,
      "banddata":<Double[]_value>,
      "banddatanew":<Double[]_value>,
      "accesscount":<Double[]_value>,
      "accessratio":<Double[]_value>,
      "accessrationew":<Double[]_value>,
      "totals":<Integer[]_value>,
      "reqbandsize":<Integer_value>,
      "respbandsize":<Integer_value>
}]}