24 lines
5.3 KiB
HTML
24 lines
5.3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>lean_data</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">lean_data</p>
|
|
<P>Configuration for API to provide the report for lean data. resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">appname<span class="property_type"><String></span></p><p class="property_description">Application Name.<br> Maximum length = 255</p>
|
|
<p class="property_name">ctnsappname<span class="property_type"><String></span></p><p class="property_description">Vserver name.<br> Maximum length = 255</p>
|
|
<p class="property_name">throughput<span class="property_type"><Double></span></p><p class="property_description">Throughput.</p>
|
|
<p class="property_name">rpt_sample_time<span class="property_type"><Double></span></p><p class="property_description">Report Sample time..</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">Netscaler IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">total_bytes<span class="property_type"><Double></span></p><p class="property_description">Total bytes consumed..</p>
|
|
<p class="property_name">total_requests<span class="property_type"><Double></span></p><p class="property_description">Total requests..</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/lean_data</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">total_bytes, throughput, app_launch_count</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "lean_data":[{<br> "appname":<String_value></font>,<br> "ctnsappname":<String_value></font>,<br> "throughput":<Double_value></font>,<br> "rpt_sample_time":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "total_bytes":<Double_value></font>,<br> "total_requests":<Double_value></font>}]}</p>
|
|
</body>
|
|
</html>
|