The jobqueueQueueStats Web API Method

Get queue live statistics - running and pending jobs.

Version: 1.10

Required Permissions: Full

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
queue_id	Integer	No	Gets stats for the requested queue only.

Expected Response Code: 200 OK - Returned for a successful request.

Possible Action Specific Error Codes: None.

Example

Usage Example

Request

GET /ZendServer/Api/jobqueueQueueStats

Response

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.10">
	<requestData>
		<apiKeyName>
			<![CDATA[admin]]>
		</apiKeyName>
		<method>jobqueueQueueStats</method>
	</requestData>
	<responseData>
		<queueStats>
			<item>
				<queue_id>2</queue_id>
				<running_jobs_count>0</running_jobs_count>
				<pending_jobs_count>2</pending_jobs_count>
			</item>
			<item>
				<queue_id>3</queue_id>
				<running_jobs_count>1</running_jobs_count>
				<pending_jobs_count>3</pending_jobs_count>
			</item>
			<item>
				<queue_id>4</queue_id>
				<running_jobs_count>2</running_jobs_count>
				<pending_jobs_count>4</pending_jobs_count>
			</item>
		</queueStats>
	</responseData>
</zendServerAPIResponse>