xdmp.forestBackupStatus

xdmp.forestbackupstatusxdmpforestbackupstatus

/apidoc/8.0/xdmp:forest-backup-status.xml

Checks the status of the specified forests for any outstanding backup jobs. Returns the specified forests portion a database backup status as a JSON node.

One or more forest IDs.

forestid

String[]

ObjectNode*

http://marklogic.com/xdmp/privileges/xdmp-database-backup-status

forest

The forest being backed up. There is one forest element for each forest in the backup.

forestName

The name of the forest.

forestId

The forest ID.

status

The status of the forest backup. The status is one of: "queued", "in-progress", "failed", "canceled", completed", or "unknown".

restoreToTime

The date and time this backup was created.

journalArchiving

Is journal archiving enabled for a full backup?

journalArchivePath

Path to the associated journal archive location.

safeRestoreToTime

The date and time this backup was created.

journalArchiveLagLimit

Number of seconds the archived journal can lag the active journal.

hostName

Hostname where this forest is backup.

backupPath

Path to the backup location.

incrementalBackupPath

Path to the backup location.

jobId

The job ID.

status

The status of the forest backup. The status is one of: "queued", "in-progress", "failed", "canceled", completed", or "unknown".

xdmp.forestBackupStatus(xdmp.forest("My-Forest"));
=>
{
  "jobId":"1261339155818839957",
  "forests":
  {
   "forestName":"bill",
   "forestId":"7201957734358937355",
   "status":"completed",
   "incrementalBackup":"false",
   "journalArchiving":"false"
   }
}