Last modified October 31, 2024

Queues

addQueueItems

This function lets you Queue Backup Items for restore or download.

getQueueGroup

This function returns queue group objects by ID.

getQueueItem

This function returns queue item objects by ID.

listQueueGroups

This function returns a list of queue groups by queue type.

listQueueItems

This function returns a list of queue items associated with the specified queue group ID.

clearQueue

This function lets you clear all non-pending/non-processing items in the queue.

stopQueueGroup

This function lets you stop a pending or currently processing queue group given its object ID.

stopAllQueueGroup

This function lets you stop all pending and currently processing groups in the queue.

manageQueuePriority

This function lets you create and manage Queue Priority Groups.

getQueuePriority

This function returns queue priority object by ID.

listQueuePriorities

This function returns a list of queue priority objects.

deleteQueuePriority

This function lets you delete a Queue Priority Group given its object ID.

rerunFailedQueueGroup

This function retries failed items and is only available for Failed or Partially Completed backup jobs.

Parameter Dictionary

Queue Group Object

Queue Group Object
Parameter name Type Description Examples
_id String Unique ID of the Queue Group Object. 60835efa26762d5a3134394e
owner String Unique ID of the backup owner. 6009c86db68d1601154a76ff
owner_name String Name of the backup owner. user
created String Date-time when the Queue Group was generated. 2021-04-23T23:57:46+00:00
started String Date-time when the Queue Group started processing 2021-04-23T23:57:46+00:00
ended String Date-time when the Queue Group finished processing 2021-04-24T01:09:10+00:00
type Integer Queue Type for the Queue Group Object.
  • 1 (backup)
  • 2 (restore)
  • 4 (download)
  • 8 (reindex)
items Integer Number of items in the Queue Group. 5
items_completed Integer Number of items that has completed processing in the Queue Group. 5
finalize boolean flag Flags if all items in the Queue Group has been completed
  • 1 (true)
  • empty/null (false)
status Integer Status of the Queue Group process
  • 1: Pending
  • 2: Processing
  • 100: Completed
  • 101: Partially Completed
  • 102: Failed
  • 103: Aborted
  • 104: Never Finished
log_id String Unique ID of the log associated to the Queue Group. 608222b9c268d2175921b412
status_time String Date-time when the status was last updated 2021-04-23T01:28:43+00:00
execution_time Integer Time it took for the Queue Group to be queued until it completes processing, in seconds. 3685
actual_time Integer Time it took for the Queue Group to complete processing, in seconds. 3143
log_file String Path of the log associated to the Queue Group. /usr/local/jetapps/var/log /jetbackup5/queue/2_60835e6f26762d5a3134394c.log
data List [] A list of corresponding data associated with the Queue Group Type.
  • Queue Type 1:
    • _id (string): destination ID
    • name (string): destination name
    • snapshot (boolean): Backup on Demand
    • manually (boolean): Manually executed backup
  • Queue Type 2 & 4:
    • account (string): account name
    • priority (integer): account priority level
  • Queue Type 8:
    • _id (string): destination ID
    • name (string): destination name

Queue Item Object

Queue Priority Object
Parameter name Type Description Possible values Example
_id String The ID of the queue priority group.   '_id=60898b7f2ba85218685acfd9'
name String Queue priority group name.   'name=VIP'
tags List [] List of Account Tag IDs that is associated to the queue priority group.   'tags[]=608b077566c0e32488215a62'
backup_priority Integer The backup priority level of the queue priority group.    
restore_priority Integer The restore priority level of the queue priority group.    
download_priority Integer The download priority level of the queue priority group.    
default Boolean Whether the queue priority group is the default group.
  • 1 (true)
  • empty/null (false)
  

Queue Priority Object

Queue Priority Object
Parameter name Type Description Possible values Example
_id String The ID of the queue priority group.   '_id=60898b7f2ba85218685acfd9'
name String Queue priority group name.   'name=VIP'
tags List [] List of Account Tag IDs that is associated to the queue priority group.   'tags[]=608b077566c0e32488215a62'
backup_priority Integer The backup priority level of the queue priority group.    
restore_priority Integer The restore priority level of the queue priority group.    
download_priority Integer The download priority level of the queue priority group.    
default Boolean Whether the queue priority group is the default group.
  • 1 (true)
  • empty/null (false)