The QueueInfo
action provides information about the asynchronous actions that the ACI server has queued, is processing, or has finished. You can use the QueueInfo
action to:
When you use QueueAction=getStatus
to check the status of actions, you can use the Sort-By
and Sort-Order
parameters to sort the returned actions. If you do not specify these parameters, the actions are sorted by the time they were received, with the most recent action listed first. You can also use the State
parameter to filter the actions that are returned by their status.
QueueInfo
is a synchronous action.
Parameter | Description | Required |
---|---|---|
ActionID | A string to use to identify an ACI action. | No |
Priority | To change the priority of an action using QueueAction=changePriority , specify the new priority as an integer. |
Required when QueueAction=changePriority |
QueueAction | The action to perform on the queue. | Yes |
QueueName | The name of the queue to query. There is one queue for each asynchronous action. |
Yes |
Token | To specify a single action in the queue, specify the token. | Required when QueueAction=cancel or QueueAction=changePriority |
When QueueAction=getStatus
, you can use the following action parameters to filter and sort the actions that are returned:
Parameter | Description | Required |
---|---|---|
Finished-After | Return actions that finished after the specified time. | No |
Finished-Before | Return actions that finished before the specified time. | No |
Max-Priority | Return actions with a priority the same as or lower than the specified value. | No |
MaxResults | The maximum number of results to return in response to a request with QueueAction=getStatus . |
No |
Min-Priority | Return actions with a priority the same as or higher than the specified value. | No |
Queued-After | Return actions that were added to the queue after the specified time. | No |
Queued-Before | Return actions that were added to the queue before the specified time. | No |
Sort-By | The property to use to sort the actions that are returned (queue-time , start-time , finish-time ). |
No |
Sort-Order | The order used to sort the actions that are returned (ascending , descending ). |
No |
Start | The index of the first result to return in response to a request with QueueAction=getStatus . The index of the first result is 1 . |
No |
Started-After | Return actions that began processing after the specified time. | No |
Started-Before | Return actions that began processing before the specified time. | No |
State | The actions to return, based on their current state (queued , running , finished ). This parameter accepts a comma-separated list of states. If you do not set this parameter, information is returned for all actions. |
No |
To return the status of all actions in the specified action queue:
http://localhost:1234/action=QueueInfo &QueueAction=GetStatus &QueueName=
To return the status and results of the ten most recently finished actions in the specified queue, sorted by the time the server finished processing them, with the most recently completed action listed first:
http://localhost:1234/action=QueueInfo &QueueAction=GetStatus &QueueName= &State=finished &Sort-By=finish-time &Sort-Order=descending &MaxResults=10 &Start=1
To change the priority of an action:
http://localhost:1234/action=QueueInfo &QueueAction=changePriority &QueueName= &Token=MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4 &priority=100
To return the action parameters passed to an action that is pending or in progress:
http://localhost:1234/action=QueueInfo &QueueAction=getActionParameters &QueueName= &Token=MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4
The following XML is a sample response from the QueueInfo
action, with the parameter QueueAction=getActionParameters
. The full action was action=queueinfo&queuename=fetch&queueaction=getActionParameters&token=...
, because this example was sent to a connector.
The <status>
element can return Queued
, Processing
, Finished
, or Error
. You cannot view the parameters for an action that has finished or failed, so the <parameters>
element is not present for those actions.
<autnresponse xmlns:autn="http://schemas.autonomy.com/aci/"> <action>QUEUEINFO</action> <response>SUCCESS</response> <responsedata> <request> <token>MTAuMi4xMDUuMTEyOjcwMDQ6RkVUQ0g6LTY1OTA0MjI4Mg==</token> <status>Queued</status> <parameters> <parameter name="TaskSections" value="MyTask1"/> <parameter name="FetchAction" value="Synchronize"/> </parameters> </request> </responsedata> </autnresponse>
|