- Index
- Preface
- Introduction to the Cisco WAAS Central Manager Monitoring API
- Device Configuration Service
- Traffic Acceleration Service
- Video Streaming Statistics Service
- HTTP Statistics Service
- MAPI Statistics Service
- NFS Statistics Service
- SSL Statistics Service
- CIFS Statistics service
- Events and Status Service
- Web Service Objects
Cisco Wide Area Application Services API Reference (Software Version 4.4.1)
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- March 18, 2015
Chapter: HTTP Statistics Service
HTTP and HTTPS Statistics Services
This chapter describes the HTTP and HTTPS Statistics service, which returns HTTP and HTTPS connection information and statistics for individual WAEs, device groups, and for the WAAS network.
HTTP Service
The HTTP service (HttpStats Web Service) performs one or more of the following actions:
Syntax
Service URL: https://<host/ip>:8443/ws/HttpStats
WSDL URL: https://<host/ip>:8443/ws/HttpStats?wsdl
To obtain a description of all the operations and parameters for the HttpStats Web Service, submit a URL to the service with the suffix ?wsdl as follows:
https://<host/ip>:8443/ws/HttpStats?wsdl
To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:
https://<host/ip>:8443/ws/HttpStats
Next, submit a SOAP request written in an XML format to retrieve the information.
The following example shows an XML-formatted SOAP request perform the getOptConnCount action. The request includes the input parameters for this particular action shown in bold. The next example shows the XML response that contains the output values for this action.
Example Request
<?xml version="1.0" encoding="utf-8" ?>
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Header>
- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0. xsd">
- <wsse:UsernameToken>
<wsse:Username>admin</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#P asswordText">default</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
- <soapenv:Body>
- <ns3:getOptConnCount xmlns:ns3="http://service.stats.ws.waas.cisco.com">
<ns3:name>ce-119-40</ns3:name>
<ns3:objType>wae</ns3:objType>
- <ns3:timeframe>
<ns2:endTime xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-30T08:00:00.000Z</ns2:endTime>
<ns2:frequency xmlns:ns2="http://util.ws.waas.cisco.com/xsd">lasthour</ns2:frequency>
<ns2:startTime xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-01T08:00:00.000Z</ns2:startTime>
<ns2:timezone xmlns:ns2="http://util.ws.waas.cisco.com/xsd">UTC</ns2:timezone>
</ns3:timeframe>
</ns3:getOptConnCount>
</soapenv:Body>
</soapenv:Envelope>
Example Response
<?xml version="1.0" encoding="utf-8" ?>
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Body>
- <ns:getOptConnCountResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" xmlns:ax218="http://util.ws.waas.cisco.com/xsd" xmlns:ax216="http://rmi.java/xsd" xmlns:ax219="http://stats.ws.waas.cisco.com/xsd" xmlns:ax217="http://io.java/xsd">
- <ns:return type="com.cisco.waas.ws.stats.HttpOptConnCount">
<ax219:endtime>2008-04-16T17:39:17.818Z</ax219:endtime>
<ax219:fastConnectionSetupsCount>31</ax219:fastConnectionSetupsCount>
<ax219:frequency>min</ax219:frequency>
</ns:return>
- <ns:return type="com.cisco.waas.ws.stats.HttpOptConnCount">
<ax219:endtime>2008-04-16T17:44:18.703Z</ax219:endtime>
<ax219:fastConnectionSetupsCount>23</ax219:fastConnectionSetupsCount>
<ax219:frequency>min</ax219:frequency>
</ns:return>
</ns:getOptConnCountResponse>
</soapenv:Body>
</soapenv:Envelope>
getOptConnCount
Retrieves the number of optimized HTTP connections for a WAE, WAE group, or all WAEs system wide. If you specify a time interval, the timeframe is divided into time segments. The connection count is calculated for each segment of time.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpOptConnCount[] returns a HttpOptConnCount value that provides an array of HTTP traffic optimized connection statistics.
Exceptions
getTotalConnCount
Retrieves the total number of HTTP connections for a WAE, WAE group, or all WAEs system wide. If you specify a time interval, the timeframe is divided into time segments. The connection count is calculated for each segment of time.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpTotalConnCount[] returns a HttpTotalConnCount value that provides an array of HTTP traffic total connection statistics.
Exceptions
getMaxConnReuseCount
Retrieves the maximum reuse count of a single connection.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpMaxConnReuseCount[] returns a HttpMaxConnReuseCount value that provides the maximum reuse count of a single connection.
Exceptions
getConnOptRate
Retrieves an estimate of the connection setup time saved by HTTP AO as a function of the connection reuse and round-trip time (RTT) for establishing the original connection.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpConnOptRate[] returns a HttpConnOptRate value that provides the percentage that the optimized connection time saved.
Exceptions
retrieveStats
Retrieves the HTTP connection statistics, such as response times and counts per operation.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpConnStats[] returns a HttpConnStats value that provides the response time, counter per operation, and other statistics.
Exceptions
retrieveResponseStats
Retrieves the HTTP connection response RTT savings statistics.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpResponseStats[] returns a HttpResponseStats value that provides the response time savings statistics.
Exceptions
|
|
|
|
RemoteException |
HttpStatsService.retrieveResponseStats:ERROR:Unable to get HttpResponseStats= |
Unknown exception. See the logs to view the error. |
getConnOptType
Retrieves the HTTP optimization connection statistics.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpConnOptType[] returns a HttpConnOptType value that provides the connection optimization type distribution statistics.
Exceptions
|
|
|
|
RemoteException |
HttpStatsService.getConnOptType: |
Unknown exception. See the logs to view the error. |
getUnaccelConnCount
Retrieves a list of unaccelerated connection counts.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpUnaccelConnCount[] returns a HttpUnaccelConnCount value that provides the number of past connections from each client type.
Exceptions
|
|
|
|
RemoteException |
HttpStatsService.getUnaccelConnCount:ERROR:Unable to get HttpUnaccelConnCount= |
Unknown exception. See the logs to view the error. |
HTTPS Service
The HTTPS service (HttpsStats Web Service) performs one or more of the following actions:
Syntax
Service URL: https://<host/ip>:8443/ws/HttpsStats
WSDL URL: https://<host/ip>:8443/ws/HttpsStats?wsdl
To obtain a description of all the operations and parameters for the HttpsStats Web Service, submit a URL to the service with the suffix ?wsdl as follows:
https://<host/ip>:8443/ws/HttpsStats?wsdl
To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:
https://<host/ip>:8443/ws/HttpsStats
Next, submit a SOAP request written in an XML format to retrieve the information.
The following example shows an XML-formatted SOAP request perform the getConnOptType action. The request includes the input parameters for this particular action shown in bold. The next example shows the XML response that contains the output values for this action.
Example Request
<?xml version="1.0" encoding="utf-8" ?>
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Header>
- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0. xsd">
- <wsse:UsernameToken>
<wsse:Username>admin</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#P asswordText">default</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
- <soapenv:Body>
- <ns3:getConnOptType xmlns:ns3="http://service.stats.ws.waas.cisco.com">
<ns3:name>ce-119-40</ns3:name>
<ns3:objType>wae</ns3:objType>
- <ns3:timeframe>
<ns2:endTime xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-30T08:00:00.000Z</ns2:endTime>
<ns2:frequency xmlns:ns2="http://util.ws.waas.cisco.com/xsd">lasthour</ns2:frequency>
<ns2:startTime xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-01T08:00:00.000Z</ns2:startTime>
<ns2:timezone xmlns:ns2="http://util.ws.waas.cisco.com/xsd">UTC</ns2:timezone>
</ns3:timeframe>
</ns3:getConnOptType>
</soapenv:Body>
</soapenv:Envelope>
Example Response
<?xml version="1.0" encoding="utf-8" ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
- <soapenv:Body>
- <ns:getConnOptTypeResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" xmlns:ax238="http://rmi.java/xsd" xmlns:ax241="http://stats.ws.waas.cisco.com/xsd" xmlns:ax240="http://util.ws.waas.cisco.com/xsd" xmlns:ax239="http://io.java/xsd">
- <ns:return type="com.cisco.waas.ws.stats.HttpsConnOptType">
<ax241:deviceName>gowri-wae-2</ax241:deviceName>
<ax241:dreHintsFlush>0</ax241:dreHintsFlush>
<ax241:dreHintsSkipAllHeaders>0</ax241:dreHintsSkipAllHeaders>
<ax241:dreHintsSkipLz>0</ax241:dreHintsSkipLz>
<ax241:endTime>2010-10-07T04:59:57.671Z</ax241:endTime>
<ax241:frequency>min</ax241:frequency>
<ax241:locallyServedIfNotModified>0</ax241:locallyServedIfNotModified>
<ax241:locallyServedRedirect>0</ax241:locallyServedRedirect>
<ax241:locallyServedUnauthorized>0</ax241:locallyServedUnauthorized>
</ns:return>
</ns:getConnOptTypeResponse>
</soapenv:Body>
</soapenv:Envelope>
retrieveStats
Retrieves the HTTPS connection statistics, such as response times and counts per operation.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpsStats[] returns a HttpsStats value that provides the response time, counter per operation, and other statistics.
Exceptions
retrieveResponseStats
Retrieves the HTTPS connection response RTT savings statistics.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpsResponseStats[] returns a HttpsResponseStats value that provides the response time savings statistics.
Exceptions
getConnOptType
Retrieves the HTTPS optimization connection statistics.
Input Parameters
|
|
|
|---|---|
name |
A string that describes the name of the WAE, WAE group, or system. |
objType |
A string that describes the object type. Valid values include the following: • • • • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter HttpsConnOptType[] returns a HttpsConnOptType value that provides the connection optimization type distribution statistics.
Exceptions
Feedback