ADC NITRO APIs

protocolhttpband

August 17, 2023

Contributed by:

Configuration for HTTP request/response band resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
reqbandsize		Read-write	Band 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 0 - 99 bytes 100 - 199 bytes 200 - 299 bytes and so on. Default value: 100 Minimum value = 50
respbandsize		Read-write	Band 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 0 - 99 bytes 100 - 199 bytes 200 - 299 bytes and so on. Default value: 1024 Minimum value = 50
type		Read-write	Type of statistics to display. Possible values = REQUEST, RESPONSE
nodeid		Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
bandrange		Read-only	The range of the HTTP request/response size, in bytes.
numberofbands		Read-only	The total number of http bands.
totalbandsize	<Double[]>	Read-only	The total size of all HTTP requests/responses in this size range.
avgbandsize	<Double[]>	Read-only	The average size of all HTTP requests/responses in this size range.
avgbandsizenew	<Double[]>	Read-only	The average size of all HTTP requests/responses in this size range.
banddata	<Double[]>	Read-only	The 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-only	The 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-only	The number of HTTP requests/responses in this size range.
accessratio	<Double[]>	Read-only	The number of HTTP requests/responses in this size range, expressed as a percentage of the total number of HTTP requests/responses.
accessrationew	<Double[]>	Read-only	The number of HTTP requests/responses in this size range, expressed as a percentage of the total number of HTTP requests/responses.
totals	<Integer[]>	Read-only	The total of totalBandSize, avgBandSize, BandData, accessCount, accessRatio respectively.

Operations

(click to see Properties )

UPDATE
UNSET
GET (ALL)
CLEAR

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>
}}

<!--NeedCopy-->

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
}}

<!--NeedCopy-->

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":{
<b>      "type":<String_value>
</b>}}

<!--NeedCopy-->

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 error

Response Header:

Content-Type:application/json

Response Payload:

{ "protocolhttpband": [ {
<b>type:<String_value>,</b>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>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

protocolhttpband

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

protocolhttpband

Properties

Operations

update

unset

clear

get (all)

In this article