ADC NITRO APIs

protocolhttp2

Statistics for http2 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
http2requests <Double> Read-only Total number of http2 requests
http2requestsrate <Double> Read-only Rate (/s) counter for http2requests
http2responses <Double> Read-only Total number of http2 responses
http2responsesrate <Double> Read-only Rate (/s) counter for http2responses
http2totgrpcrequest <Double> Read-only Total number of gRPC requests
http2grpcrequestrate <Double> Read-only Rate (/s) counter for http2totgrpcrequest
http2totgrpcresponse <Double> Read-only Total number of gRPC responses
http2grpcresponserate <Double> Read-only Rate (/s) counter for http2totgrpcresponse
http2totgrpcsuccess <Double> Read-only Total number of gRPC success
http2grpcsuccessrate <Double> Read-only Rate (/s) counter for http2totgrpcsuccess
http2totgrpcfailure <Double> Read-only Total number of gRPC failures
http2grpcfailurerate <Double> Read-only Rate (/s) counter for http2totgrpcfailure
http2direct <Double> Read-only Total number of http2 direct connections established
http2directrate <Double> Read-only Rate (/s) counter for http2direct
http2serverdirect <Double> Read-only Number of HTTP/2 server direct
http2serverdirectrate <Double> Read-only Rate (/s) counter for http2serverdirect
http2requpg <Double> Read-only Total number of connections upgraded to HTTP2
http2requpgrate <Double> Read-only Rate (/s) counter for http2requpg
http2nomatcipher <Double> Read-only Total number of cipher mismatch failures
http2nomatcipherrate <Double> Read-only Rate (/s) counter for http2nomatcipher
http2serverdirectfailed <Double> Read-only Number of HTTP/2 server direct failed
http2serverdirectfailedrate <Double> Read-only Rate (/s) counter for http2serverdirectfailed
http2serverupgradefailed <Double> Read-only Number of HTTP/2 server upgrade failed
http2serverupgradefailedrate <Double> Read-only Rate (/s) counter for http2serverupgradefailed
http2requestupgradefailed <Double> Read-only Number of HTTP/2 request upgrade failed
http2requestupgradefailedrate <Double> Read-only Rate (/s) counter for http2requestupgradefailed
http2dataframessent <Double> Read-only Number of HTTP/2 DATA frames sent
http2dataframessentrate <Double> Read-only Rate (/s) counter for http2dataframessent
http2headerframessent <Double> Read-only Number of HTTP/2 HEADER frames sent
http2headerframessentrate <Double> Read-only Rate (/s) counter for http2headerframessent
http2priorityframessent <Double> Read-only Number of HTTP/2 PRIORITY frames sent
http2priorityframessentrate <Double> Read-only Rate (/s) counter for http2priorityframessent
http2rststreamframessent <Double> Read-only Number of HTTP/2 RST_STREAM frames sent
http2rststreamframessentrate <Double> Read-only Rate (/s) counter for http2rststreamframessent
http2settingframessent <Double> Read-only Number of HTTP/2 SETTINGS frames sent
http2settingframessentrate <Double> Read-only Rate (/s) counter for http2settingframessent
http2pushpromiseframessent <Double> Read-only Number of HTTP/2 PUSH_PROMISE frames sent
http2pushpromiseframessentrate <Double> Read-only Rate (/s) counter for http2pushpromiseframessent
http2pingframessent <Double> Read-only Number of HTTP/2 PING frames sent
http2pingframessentrate <Double> Read-only Rate (/s) counter for http2pingframessent
http2goawayframessent <Double> Read-only Number of HTTP/2 GOAWAY frames sent
http2goawayframessentrate <Double> Read-only Rate (/s) counter for http2goawayframessent
http2windowupdateframessent <Double> Read-only Number of HTTP/2 WINDOW_UPDATE frames sent
http2windowupdateframessentrate <Double> Read-only Rate (/s) counter for http2windowupdateframessent
http2continuationframessent <Double> Read-only Number of HTTP/2 CONTINUATION frames sent
http2continuationframessentrate <Double> Read-only Rate (/s) counter for http2continuationframessent
http2altsvcframessent <Double> Read-only Number of HTTP/2 ALTSVC frames sent
http2altsvcframessentrate <Double> Read-only Rate (/s) counter for http2altsvcframessent
http2dataframesrcvd <Double> Read-only Number of HTTP/2 DATA frames received
http2dataframesrcvdrate <Double> Read-only Rate (/s) counter for http2dataframesrcvd
http2headerframesrcvd <Double> Read-only Total number of http2 header frames received
http2headerframesrcvdrate <Double> Read-only Rate (/s) counter for http2headerframesrcvd
http2priorityframesrcvd <Double> Read-only Total number of http2 priority frames received
http2priorityframesrcvdrate <Double> Read-only Rate (/s) counter for http2priorityframesrcvd
http2rststreamframesrcvd <Double> Read-only Number of HTTP/2 RST_STREAM frames received
http2rststreamframesrcvdrate <Double> Read-only Rate (/s) counter for http2rststreamframesrcvd
http2settingframesrcvd <Double> Read-only Number of HTTP/2 SETTINGS frames received
http2settingframesrcvdrate <Double> Read-only Rate (/s) counter for http2settingframesrcvd
http2pushpromframesrcvd <Double> Read-only Number of HTTP/2 PUSH_PROMISE frames received
http2pushpromframesrcvdrate <Double> Read-only Rate (/s) counter for http2pushpromframesrcvd
http2pingframesrcvd <Double> Read-only Number of HTTP/2 PING frames received
http2pingframesrcvdrate <Double> Read-only Rate (/s) counter for http2pingframesrcvd
http2goawayframesrcvd <Double> Read-only Number of HTTP/2 GOAWAY frames received
http2goawayframesrcvdrate <Double> Read-only Rate (/s) counter for http2goawayframesrcvd
http2winupdateframesrcvd <Double> Read-only Number of HTTP/2 WINDOW_UPDATE frames received
http2winupdateframesrcvdrate <Double> Read-only Rate (/s) counter for http2winupdateframesrcvd
http2continuationframesrcvd <Double> Read-only Number of HTTP/2 CONTINUATION frames received
http2continuationframesrcvdrate <Double> Read-only Rate (/s) counter for http2continuationframesrcvd
http2indataframes <Double> Read-only Number of HTTP/2 DATA frames
http2indataframesrate <Double> Read-only Rate (/s) counter for http2indataframes
http2inheaderframes <Double> Read-only Number of HTTP/2 HEADER frames
http2inheaderframesrate <Double> Read-only Rate (/s) counter for http2inheaderframes
http2inpriorityframes <Double> Read-only Number of HTTP/2 PRIORITY frames
http2inpriorityframesrate <Double> Read-only Rate (/s) counter for http2inpriorityframes
http2inrststreamframes <Double> Read-only Number of HTTP/2 RST_STREAM frames
http2inrststreamframesrate <Double> Read-only Rate (/s) counter for http2inrststreamframes
http2insettingframes <Double> Read-only Number of HTTP/2 SETTINGS frames
http2insettingframesrate <Double> Read-only Rate (/s) counter for http2insettingframes
http2inpushpromiseframes <Double> Read-only Number of HTTP/2 PUSH_PROMISE frames
http2inpushpromiseframesrate <Double> Read-only Rate (/s) counter for http2inpushpromiseframes
http2inpingframes <Double> Read-only Number of HTTP/2 PING frames
http2inpingframesrate <Double> Read-only Rate (/s) counter for http2inpingframes
http2ingoawayframes <Double> Read-only Number of HTTP/2 GOAWAY frames
http2ingoawayframesrate <Double> Read-only Rate (/s) counter for http2ingoawayframes
http2inwindowupdateframes <Double> Read-only Number of HTTP/2 WINDOW_UPDATE frames
http2inwindowupdateframesrate <Double> Read-only Rate (/s) counter for http2inwindowupdateframes
http2incontinuationframes <Double> Read-only Number of HTTP/2 CONTINUATION frames
http2incontinuationframesrate <Double> Read-only Rate (/s) counter for http2incontinuationframes
http2frametoobig <Double> Read-only Number of HTTP/2 frames received carrying a frame length greater than SETTINGS_MAX_FRAME_SIZE sent by NetScale
http2frametoobigrate <Double> Read-only Rate (/s) counter for http2frametoobig
http2pingflood <Double> Read-only HTTP/2 number of ping frames received on connection is above rate limit
http2pingfloodrate <Double> Read-only Rate (/s) counter for http2pingflood
http2errsetflood <Double> Read-only HTTP/2 number of settings frames received on connection is above rate limit
http2errsetfloodrate <Double> Read-only Rate (/s) counter for http2errsetflood
http2errresfraflood <Double> Read-only HTTP/2 number of reset frames received on connection is above rate limit
http2errresfrafloodrate <Double> Read-only Rate (/s) counter for http2errresfraflood
http2errempfraflood <Double> Read-only HTTP/2 number of empty frames received on connection is above rate limit
http2errempfrafloodrate <Double> Read-only Rate (/s) counter for http2errempfraflood

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 red and placeholder content is marked in green

get (all)

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

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

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

{  "protocolhttp2": [ {
"http2errresfrafloodrate":<Double_value>,
"http2requpgrate":<Double_value>,
"http2dataframesrcvdrate":<Double_value>,
"http2inpriorityframesrate":<Double_value>,
"http2serverdirectrate":<Double_value>,
"http2pingfloodrate":<Double_value>,
"http2priorityframessent":<Double_value>,
"http2headerframessent":<Double_value>,
"http2serverupgradefailedrate":<Double_value>,
"http2inheaderframes":<Double_value>,
"http2rststreamframesrcvdrate":<Double_value>,
"http2pushpromframesrcvdrate":<Double_value>,
"http2inheaderframesrate":<Double_value>,
"http2responsesrate":<Double_value>,
"http2inpriorityframes":<Double_value>,
"http2pushpromiseframessentrate":<Double_value>,
"http2serverdirectfailedrate":<Double_value>,
"http2serverdirectfailed":<Double_value>,
"http2goawayframesrcvd":<Double_value>,
"http2dataframessent":<Double_value>,
"http2totgrpcrequest":<Double_value>,
"http2continuationframesrcvd":<Double_value>,
"http2responses":<Double_value>,
"http2directrate":<Double_value>,
"http2rststreamframessent":<Double_value>,
"http2serverdirect":<Double_value>,
"http2rststreamframesrcvd":<Double_value>,
"http2inwindowupdateframesrate":<Double_value>,
"http2pingflood":<Double_value>,
"http2windowupdateframessent":<Double_value>,
"http2headerframesrcvdrate":<Double_value>,
"http2grpcfailurerate":<Double_value>,
"http2continuationframessentrate":<Double_value>,
"http2pingframessent":<Double_value>,
"http2requests":<Double_value>,
"http2errsetfloodrate":<Double_value>,
"http2inpingframesrate":<Double_value>,
"http2requestsrate":<Double_value>,
"http2pushpromframesrcvd":<Double_value>,
"http2altsvcframessentrate":<Double_value>,
"http2inpingframes":<Double_value>,
"http2priorityframessentrate":<Double_value>,
"http2settingframesrcvd":<Double_value>,
"http2windowupdateframessentrate":<Double_value>,
"http2errresfraflood":<Double_value>,
"http2nomatcipherrate":<Double_value>,
"http2headerframessentrate":<Double_value>,
"http2grpcsuccessrate":<Double_value>,
"http2serverupgradefailed":<Double_value>,
"http2indataframes":<Double_value>,
"http2errsetflood":<Double_value>,
"http2goawayframessentrate":<Double_value>,
"http2headerframesrcvd":<Double_value>,
"http2frametoobig":<Double_value>,
"http2priorityframesrcvd":<Double_value>,
"http2grpcresponserate":<Double_value>,
"http2totgrpcsuccess":<Double_value>,
"http2direct":<Double_value>,
"http2incontinuationframes":<Double_value>,
"http2inrststreamframes":<Double_value>,
"http2rststreamframessentrate":<Double_value>,
"http2incontinuationframesrate":<Double_value>,
"http2requestupgradefailedrate":<Double_value>,
"http2errempfraflood":<Double_value>,
"http2continuationframessent":<Double_value>,
"http2inpushpromiseframesrate":<Double_value>,
"http2inpushpromiseframes":<Double_value>,
"http2requestupgradefailed":<Double_value>,
"http2dataframessentrate":<Double_value>,
"http2pingframesrcvdrate":<Double_value>,
"http2settingframesrcvdrate":<Double_value>,
"http2winupdateframesrcvdrate":<Double_value>,
"http2pushpromiseframessent":<Double_value>,
"http2indataframesrate":<Double_value>,
"http2errempfrafloodrate":<Double_value>,
"http2ingoawayframesrate":<Double_value>,
"http2goawayframessent":<Double_value>,
"http2totgrpcfailure":<Double_value>,
"http2dataframesrcvd":<Double_value>,
"http2requpg":<Double_value>,
"http2insettingframes":<Double_value>,
"http2nomatcipher":<Double_value>,
"http2settingframessent":<Double_value>,
"http2inwindowupdateframes":<Double_value>,
"http2priorityframesrcvdrate":<Double_value>,
"http2pingframesrcvd":<Double_value>,
"http2winupdateframesrcvd":<Double_value>,
"http2altsvcframessent":<Double_value>,
"http2pingframessentrate":<Double_value>,
"http2insettingframesrate":<Double_value>,
"http2ingoawayframes":<Double_value>,
"http2totgrpcresponse":<Double_value>,
"http2goawayframesrcvdrate":<Double_value>,
"http2continuationframesrcvdrate":<Double_value>,
"http2settingframessentrate":<Double_value>,
"http2frametoobigrate":<Double_value>,
"http2inrststreamframesrate":<Double_value>,
"http2grpcrequestrate":<Double_value>
}]}

<!--NeedCopy-->
protocolhttp2