The api/db/<dbname>/backup/status Resource

The api/db/<dbname>/backup/status resource returns the current status of the backup procedure.

For an overview see page eXtremeDB Web Service Resources

With the REST server started (listening on port 8083), the following http request will return the current status of the backup procedure:

 
    http://localhost:8083/api/db/diskdb/backup/status
            
     

The output of this endpoint is equivalent to the output of the mco_async_backup_progress_info() function. It includes the fields specified below: (For a detailed description of these fields, see the documentation for the mco_backup_progress_info_t structure)

• phase: IDLE, LOOPING, FINALIZING, or RESTORE
• max_passes
• max_steps
• pass_no

• step_no

Furthermore, the output of this endpoint contains the async object with the following fields which correspond to the fields of the mco_async_backup_progress_info_t structure (except for the active flag, which is not present in the structure and indicates whether the asynchronous backup tasks are running currently):

• active
• file_name
• last_label
• type
• compression_level
• last_error_code
• last_error_msg

Finally, the following field reports the availability of the incremental backup support in the database (as indicated by the MCO_DB_INCREMENTAL_BACKUP flag):

• incremental_enabled

Examples

When the backup procedure is inactive:

 
    {
      "incremental_enabled":  true,
      "phase":      "IDLE",
      "max_passes": 0,
      "max_steps":  0,
      "pass_no":   0,
      "step_no":   0,
      {
        "active":            false,
        "file_name":         mull,
        "last_label":        null,
        "type":              "AUTO",
        "compression_level":  0,
        "last_error_code":    0,
        "last_error_msg":    null
      }
    }
 

When the asynchronous backup procedure is started, the output may be similar to the following. Notice that although the phase field shows IDLE (meaning that no backup actions are performed at the moment of the request), the asynchronous backup procedure is still active, which is indicated by the active flag:

 
    {
      "incremental_enabled":  true,
      "phase":      "IDLE":,
      "max_passes": 0,
      "max_steps":  0,
      "pass_no":   0,
      "step_no":   0,
      "async":
	{
        "active":            true,
        "file_name":         "database.bkp",
        "last_label":        "AUTOBACKUP00001",
        "type":              "AUTO",
        "compression_level":  0,
        "last_error_code":    0,
        "last_error_msg":    ""
      }
    }