The jobqueueStatistics Web API Method

Retrieve and display JobQueue daemon statistics. Note that these statistics are collected separately from the centralized Statistics mechanism.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  None

Expected Response Code: 200 OK - Returned for successfully retrieving a list of jobs according to the provided parameters. For more information see Response Format.

Response Format: A list of jobs, their dependent information and a total count of records for the provided filter

Possible Action Specific Error Codes:

HTTP Code

 Error Code

Description

500

internalServerError

Retrieving a list of jobs failed due to an internal problem

Example

Usage Example

Request

GET /ZendServer/Api/jobqueueStatistics

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>jobqueueStatistics</method>
	</requestData>
	<responseData>
		<jobqueueStatistics>
			<waiting>0</waiting>
			<waitingPredecessor>0</waitingPredecessor>
			<inProgress>0</inProgress>
			<completed>264</completed>
			<failed>1771</failed>
			<logicallyFailed>0</logicallyFailed>
			<scheduled>7</scheduled>
			<avgWait>0</avgWait>
			<avgRun>0</avgRun>
			<added>63548</added>
			<served>336715</served>
			<startupTime>2012-12-11T11:15:37+02:00</startupTime>
			<startupTimestamp>1355217337</startupTimestamp>
		</jobqueueStatistics>
	</responseData>
<zendServerAPIResponse>