50 lines
10 KiB
HTML
50 lines
10 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>app_summary</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">app_summary</p>
|
|
<P>Configuration for APP Report table resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">state_code<span class="property_type"><Double></span></p><p class="property_description">Up:1, Down:2, OutOfService:3.</p>
|
|
<p class="property_name">application_class<span class="property_type"><String></span></p><p class="property_description">Application class.<br> Maximum length = 255</p>
|
|
<p class="property_name">total_requests<span class="property_type"><Double></span></p><p class="property_description">Total Requests.</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">issues_detected<span class="property_type"><String></span></p><p class="property_description">Array of all app issues affecting health score. Each array element tells issueId, penalty and time when it occured.<br> Maximum length = 2048</p>
|
|
<p class="property_name">clnt_connections<span class="property_type"><Double></span></p><p class="property_description">Current Client Connections.</p>
|
|
<p class="property_name">pkt_sent<span class="property_type"><Double></span></p><p class="property_description">Total Pkts Sent.</p>
|
|
<p class="property_name">appcategory<span class="property_type"><String></span></p><p class="property_description">App Category.<br> Maximum length = 255</p>
|
|
<p class="property_name">exporter_id<span class="property_type"><String></span></p><p class="property_description">Exporter ID.<br> Maximum length = 255</p>
|
|
<p class="property_name">throughput_prev<span class="property_type"><Double></span></p><p class="property_description">Throughput ..</p>
|
|
<p class="property_name">clnt_connections_prev<span class="property_type"><Double></span></p><p class="property_description">Current Client Connections.</p>
|
|
<p class="property_name">app_ssl_rating<span class="property_type"><String></span></p><p class="property_description">SSL Rating.<br> Maximum length = 50</p>
|
|
<p class="property_name">appname<span class="property_type"><String></span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
|
|
<p class="property_name">health_score<span class="property_type"><Double></span></p><p class="property_description">App Health Score.</p>
|
|
<p class="property_name">health_score_prev<span class="property_type"><Double></span></p><p class="property_description">App Health Score.</p>
|
|
<p class="property_name">throughput<span class="property_type"><Double></span></p><p class="property_description">Throughput ..</p>
|
|
<p class="property_name">pkt_recvd<span class="property_type"><Double></span></p><p class="property_description">Total Pkts Received.</p>
|
|
<p class="property_name">srvr_connections<span class="property_type"><Double></span></p><p class="property_description">Current Server Connections.</p>
|
|
<p class="property_name">total_bytes<span class="property_type"><Double></span></p><p class="property_description">Session total bytes.</p>
|
|
<p class="property_name">vsvr_ip_address<span class="property_type"><String></span></p><p class="property_description">Vserver IP Address.</p>
|
|
<p class="property_name">vservername<span class="property_type"><String></span></p><p class="property_description">Vserver Name.<br> Maximum length = 255</p>
|
|
<p class="property_name">response_time<span class="property_type"><Double></span></p><p class="property_description">total time taken by the app to send response to client.</p>
|
|
<p class="property_name">total_bytes_prev<span class="property_type"><Double></span></p><p class="property_description">Session total bytes.</p>
|
|
<p class="property_name">vslbhealth<span class="property_type"><Integer></span></p><p class="property_description">Vserver Health.</p>
|
|
<p class="property_name">total_requests_prev<span class="property_type"><Double></span></p><p class="property_description">Total Requests.</p>
|
|
<p class="property_name">curr_state<span class="property_type"><String></span></p><p class="property_description">Current State.<br> Maximum length = 50</p>
|
|
<p class="property_name">error_percentage<span class="property_type"><Double></span></p><p class="property_description">Number of 5xx response received wrt total requests.</p>
|
|
<p class="property_name">response_bytes<span class="property_type"><Double></span></p><p class="property_description">Session response bytes.</p>
|
|
<p class="property_name">__count<span class="property_type"><Double></span></p><p class="property_description">count..</p>
|
|
<p class="property_name">hostname<span class="property_type"><String></span></p><p class="property_description">NetScaler Hostname.</p>
|
|
<p class="property_name">srvr_connections_prev<span class="property_type"><Double></span></p><p class="property_description">Current Server Connections.</p>
|
|
<p class="property_name">request_bytes<span class="property_type"><Double></span></p><p class="property_description">Session request bytes.</p>
|
|
<p class="property_name">app_family<span class="property_type"><String></span></p><p class="property_description">Application Family.</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/app_summary</span></p><p class="key">Query-parameters:<span class="url_value"></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>, "app_summary":[{<br> "state_code":<Double_value></font>,<br> "application_class":<String_value></font>,<br> "total_requests":<Double_value></font>,<br> "rpt_sample_time":<Double_value></font>,<br> "issues_detected":<String_value></font>,<br> "clnt_connections":<Double_value></font>,<br> "pkt_sent":<Double_value></font>,<br> "appcategory":<String_value></font>,<br> "exporter_id":<String_value></font>,<br> "throughput_prev":<Double_value></font>,<br> "clnt_connections_prev":<Double_value></font>,<br> "app_ssl_rating":<String_value></font>,<br> "appname":<String_value></font>,<br> "health_score":<Double_value></font>,<br> "health_score_prev":<Double_value></font>,<br> "throughput":<Double_value></font>,<br> "pkt_recvd":<Double_value></font>,<br> "srvr_connections":<Double_value></font>,<br> "total_bytes":<Double_value></font>,<br> "vsvr_ip_address":<String_value></font>,<br> "vservername":<String_value></font>,<br> "response_time":<Double_value></font>,<br> "total_bytes_prev":<Double_value></font>,<br> "vslbhealth":<Integer_value></font>,<br> "total_requests_prev":<Double_value></font>,<br> "curr_state":<String_value></font>,<br> "error_percentage":<Double_value></font>,<br> "response_bytes":<Double_value></font>,<br> "__count":<Double_value></font>,<br> "hostname":<String_value></font>,<br> "srvr_connections_prev":<Double_value></font>,<br> "request_bytes":<Double_value></font>,<br> "app_family":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|