-
Notifications
You must be signed in to change notification settings - Fork 3
get_replication_queue
Gets the list of backups in the replication queue based on a set of filters. Items in the replication queue are either waiting to replicate or actively replicating. Users may get just the active or waiting items by adding either active or inactive to the URL of the API.
This API utilizes the BPL API bp_get_replication_queue and merges it with information required to view the queue of backups in a clear way, much as the replication dashboard web service does.
GET /replication/queue/active returns the same data as GET /jobs/active/replication.
If run on a target, it gets the queue of all sources.
GET /api/replication/queue
GET /api/replication/queue/active
GET /api/replication/queue/inactive
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>
None.
200 success
Returns an overall count of the number of items in the wait queue along with the start position of the first item returned.
| Index | Value | Type | Returned |
|---|---|---|---|
| active | array of active replications | array | always, may be empty |
| inactive | array of waiting replications | array | always, may be empty |
The active replications return the same data as returned in GET /jobs/active/replication.
The inactive replications return information about the wait status of each item in the queue.
| Index | Value | Type | Returned |
|---|---|---|---|
| queue_position | position in replication queue | long | always |
| target | resolvable name of target | string | always |
| backup_id | id of the backup to replication | long | always |
| type | nicely formatted backup type | string | always |
| name | name of client or instance (if client is a "dummy") | string | always (this needs more definition) |
| instance_name | name of instance | string | always |
| size | backup size in MB | long | always |
| start_date | date backup started | string | always |
| status | replication status | string | always |
- | Needed |
- | Failed |
- | Aborted |
- | Terminated |
GET /api/replication/queue
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324
{
"data": [
{
"start_position": 1,
"total_inactive": 2,
"active": [
{
"id": 51904,
"client_name": "mynas-NAS",
"instance_name": "file-level",
"system_name": "UEB-1",
"type": "replication",
"schedule_name": "Replication Job",
"mode": "Full",
"sid": 2,
"name": "Target Procesing (4/4)",
"target": "UnitrendsCloud-1",
"backup_id": 49042,
"size": 3136,
"data_written": 2142,
"start_date": "2014-10-22T08:09:06-4:00",
"duration": "01:28:16",
"percent_complete": "68.3%",
"phase_start_date": "2014-10-23T01:09:06-4:00",
"phase_completion": "2 minutes",
"phase_elapsed_time": "00:14:02",
"status": "running",
"suspendable": false,
"cancellable": true
}
],
"inactive": [
{
"queue_position": 19510,
"target": "UnitrendsCloud-1",
"backup_id": 49043,
"type": "Full",
"name": "win32",
"instance_name": "file-level",
"size": 3136,
"start_date": "2014-10-21T08:09:06-4:00",
"status": "Needed"
},
{
"queue_position": 19511,
"target": "UnitrendsCloud-1",
"backup_id": 49043,
"type": "Full",
"name": "win32",
"application_name": "Exchange 2012",
"instance_name": "db_1",
"size": 430,
"start_date": "2014-10-20T08:09:06-4:00",
"status": "Failed"
}
]
}
]
}