ADC NITRO APIs

protocolhttp3

Statistics for http3 resource.

Properties

(click to see Operations )

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

Possible values = basic, full
http3requestsrcvd <Double> Read-only Total number of HTTP/3 requests received
http3requestsrcvdrate <Double> Read-only Rate (/s) counter for http3requestsrcvd
http3requestssent <Double> Read-only Total number of HTTP/3 requests sent
http3requestssentrate <Double> Read-only Rate (/s) counter for http3requestssent
http3responsesrcvd <Double> Read-only Total number of HTTP/3 responses received
http3responsesrcvdrate <Double> Read-only Rate (/s) counter for http3responsesrcvd
http3responsessent <Double> Read-only Total number of HTTP/3 responses sent
http3responsessentrate <Double> Read-only Rate (/s) counter for http3responsessent
http3conninfalcfail <Double> Read-only Number of HTTP/3 connection-info allocation failures
http3conninfalcfailrate <Double> Read-only Rate (/s) counter for http3conninfalcfail
http3nsbalcfail <Double> Read-only Number of HTTP/3 NSB allocation failures
http3nsbalcfailrate <Double> Read-only Rate (/s) counter for http3nsbalcfail
http3strminfalcfail <Double> Read-only Number of HTTP/3 stream-info allocation failures
http3strminfalcfailrate <Double> Read-only Rate (/s) counter for http3strminfalcfail
http3strmpcbalcfail <Double> Read-only Number of HTTP/3 stream PCB allocation failures
http3strmpcbalcfailrate <Double> Read-only Rate (/s) counter for http3strmpcbalcfail

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/protocolhttp3 Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/protocolhttp3? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

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

{  "protocolhttp3": [ {
"http3strmpcbalcfail":<Double_value>,
"http3responsesrcvdrate":<Double_value>,
"http3conninfalcfail":<Double_value>,
"http3requestsrcvdrate":<Double_value>,
"http3responsesrcvd":<Double_value>,
"http3requestssent":<Double_value>,
"http3responsessentrate":<Double_value>,
"http3strmpcbalcfailrate":<Double_value>,
"http3strminfalcfailrate":<Double_value>,
"http3nsbalcfail":<Double_value>,
"http3requestsrcvd":<Double_value>,
"http3conninfalcfailrate":<Double_value>,
"http3nsbalcfailrate":<Double_value>,
"http3requestssentrate":<Double_value>,
"http3strminfalcfail":<Double_value>,
"http3responsessent":<Double_value>
}]}

<!--NeedCopy-->
protocolhttp3