QueueInfo

The QueueInfo action provides information about the asynchronous actions that are running or finished. You can use the QueueInfo action to determine whether an action has finished, and retrieve the results of the action.

Type: synchronous

Parameter Description Required
QueueAction

The action to perform:

  • GetStatus - get the status of the action specified by the Token parameter, or all of the actions in the queue specified by the QueueName parameter when Token is not set.
  • QueueStatus - return the numbers of running and completed actions in the queue specified by QueueName.
Yes
QueueName The name of the queue to query. There is one queue for each asynchronous action. For example, you might specify Synchronize, Collect or Delete. Yes
Token To view information about a single action, specify the action token. No

Examples

To return the numbers of running and completed delete actions:

http://host:10000/action=QueueInfo
                           &QueueAction=QueueStatus
                           &QueueName=delete

To return the status of all actions in the synchronize action queue:

http://host:10000/action=QueueInfo
                           &QueueAction=GetStatus
                           &QueueName=synchronize

To return the status of the action with the specified token, in the collect action queue:

http://host:10000/action=QueueInfo
                           &QueueAction=GetStatus
                           &QueueName=collect
                           &Token=...