Data Throttling |
Top Previous Next |
The Developer can make powerful modifications to the Unified CM System database using the AXL API. Caution should always be observed during implementation since every API call impacts the system. Requesting large amounts of data or performing multiple write operations may trigger the interface throttle to return an exception. The throttle protects system resources to ensure calls are processed before AXL requests.
AXL acts as a provisioning and configuration API, not as a real-time API.
Below are some example request and response pairs that show what to expect in different throttling scenarios. Scenario 1: AXL Query request that tries to fetch more than 8MB of data.Request<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/10.0"> <soapenv:Header/> <soapenv:Body> <ns:executeSQLQuery sequence="?"> <sql>select * from enduser, device</sql> </ns:executeSQLQuery> </soapenv:Body> </soapenv:Envelope> Response<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Query request too large. Total rows matched: 2816 rows. Suggestive Row Fetch: less than 844 rows</faultstring> <detail> <axlError> <axlcode>-1</axlcode> <axlmessage>Query request too large. Total rows matched: 2816 rows. Suggestive Row Fetch: less than 844 rows</axlmessage> <request>executeSQLQuery</request> </axlError> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>
Scenario 2: Too many concurrent ExecuteSQLQuery requests.Request (repeated 3 times at the same time)<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/10.0"> <soapenv:Header/> <soapenv:Body> <ns:executeSQLQuery sequence="?"> <sql>select first 999 * from device, enduser</sql> </ns:executeSQLQuery> </soapenv:Body> </soapenv:Envelope> Response - Two requests are processed. The third one gives an error response.<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Fault> <faultcode>soapenv:Server</faultcode> <faultstring>Maximum AXL Memory Allocation Consumed. Please retry once requests in progress have completed</faultstring> <detail> <axlError> <axlcode>-1</axlcode> <axlmessage>Maximum AXL Memory Allocation Consumed. Please retry once requests in progress have completed</axlmessage> <request>executeSQLQuery</request> </axlError> </detail> </soapenv:Fault> </soapenv:Body> </soapenv:Envelope>
|