ADC NITRO APIs

streamidentifier

May 23, 2024

Contributed by:

Statistics for identifier resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name		Read-write	Name of the stream identifier. Minimum length = 1
pattern	<String[]>	Read-write	Values on which grouping is performed are displayed in the output as row titles. If grouping is performed on two or more fields, their values are separated by a question mark in the row title. For example, consider a selector that contains the expressions HTTP.REQ.URL and CLIENT.IP.SRC (in that order), on an appliance that has accumulated records of a number of requests for two URLs, example.com/page1.html and example.com/page2.html, from two client IP addresses, 192.0.2.10 and 192.0.2.11. With a pattern of ? ?, the appliance performs grouping on both fields and displays statistics for the following Requests for example.com/abc.html from 192.0.2.10, with a row title of example.com/abc.html?192.0.2.10. Requests for example.com/abc.html from 192.0.2.11, with a row title of example.com/abc.html?192.0.2.11. Requests for example.com/def.html from 192.0.2.10, with a row title of example.com/def.html?192.0.2.10. Requests for example.com/def.html from 192.0.2.11, with a row title of example.com/def.html?192.0.2.11. With a pattern of * ?, the appliance performs grouping on only the client IP address values and displays statistics for the following requests All requests from 192.0.2.10, with the IP address as the row title. All requests from 192.0.2.11, with the IP address as the row title. With a pattern of ? , the appliance performs grouping on only the URL values and displays statistics for the following requests All requests for example.com/abc.html, with the URL as the row title. All requests for example.com/def.html, with the URL as the row title. With a pattern of , the appliance displays one set of collective statistics for all the requests received, with no row title. With a pattern of example.com/abc.html ?, the appliance displays statistics for requests for example.com/abc.html from each unique client IP address. With a pattern of 192.0.2.11, the appliance displays statistics for all requests from 192.0.2.11.
clearstats		Read-write	Clear the statsistics / counters. Possible values = basic, full
sortby		Read-write	use this argument to sort by specific key. Possible values =
sortorder		Read-write	use this argument to specify sort order. Default value: SORT_DESCENDING Possible values = ascending, descending
streamobjreq		Read-only	Total number of Stream Requests recieved.
streamobjbandw		Read-only	Total Bandwidth consumed.
streamobjresptime		Read-only	Average response time of the stream session.
streamobjconn		Read-only	Current connections on the stream session.
streamobjbreachcnt		Read-only	Total Breaching Transactions in configured interval.
streamobjpktcredits		Read-only	Calculated Packet credits on current connection.
streamobjpktspersecond		Read-only	Total packets recieved in configured interval.
streamobjdroppedconns		Read-only	Total connections dropped.

Operations

(click to see Properties )

GET (ALL)
GET

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/streamidentifier Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/streamidentifier? args= name:<String_value>, pattern: <String[]_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value> ,sortby: <String_value> ,sortorder: <String_value> ,sortorder: <String_value>

Use this query-parameter to get streamidentifier resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/stat/streamidentifier? 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:

{  "streamidentifier": [ {
"name":<String_value>,
"streamobjconn":<Double_value>,
"streamobjdroppedconns":<Double_value>,
"streamobjbreachcnt":<Double_value>,
"streamobjbandw":<Double_value>,
"streamobjresptime":<Double_value>,
"streamobjpktcredits":<Double_value>,
"streamobjpktspersecond":<Double_value>,
"streamobjreq":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/streamidentifier/ 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 Header:

Content-Type:application/json

Response Payload:

{  "streamidentifier": [ {
"name":<String_value>,
"streamobjconn":<Double_value>,
"streamobjdroppedconns":<Double_value>,
"streamobjbreachcnt":<Double_value>,
"streamobjbandw":<Double_value>,
"streamobjresptime":<Double_value>,
"streamobjpktcredits":<Double_value>,
"streamobjpktspersecond":<Double_value>,
"streamobjreq":<Double_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

streamidentifier

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

streamidentifier

Properties

Operations

get (all)

get

In this article