GetUserStatus

July 21, 2025

This API can be used to retrieve detailed information of backup or restore jobs that are currently running.

The settings can be found on the AhsayCBS web console at:

Monitoring > Live Activities > Backup User > Backup Status or Restore Status

URL

https://CBS.EXAMPLE.COM/cbs/api/json/GetUserStatus.do

Available Since Version: 9.1

Parameters

Key	Type	Description
SysUser	String	Username of an AhsayCBS System User with Admin or API role.
SysPwd	String	Password matching SysUser.
Type	String	Type of job, either backup or restore.

Return Values

Key	Type	Description
Status	String	"OK" or "Error"
BkpStatus	Array of BkpStatus	If input parameter type is “backup”, array of BkpStatus is returned.
RestoreStatus	Array of RestoreStatus	If input parameter type is “restore”, array of RestoreStatus is returned.
Message	String	Error message; it only appears if status displays "Error".
ExptType	String	The type of exception, will only be displayed if the status is "Error".

JSON Objects

BkpStatus / RestoreStatus

Key	Type	Description
ID	String	ID of backup and restore job status.
LoginName	String	Name of the backup account.
Owner	String	Owner of the backup account.
UserID	String	ID of the backup account.
Alias	String	Alias of the backup account.
UserType	String	Type of user, can either be Trial or Paid.
ClientType	String	Type of backup client, can either be OBM or ACB.
Type	String	Type of backup set, the value can be one of the following: File, Cloud File, Lotus Domino, Lotus Notes, Microsoft Exchange Server, Microsoft Exchange Mail (MAPI), Microsoft SQL Server, Microsoft Windows Virtualization, Microsoft Windows System Backup, MySQL, Oracle Database Server, ShadowProtect Bare Metal, System State, VMwar Virtualization and Office 365 Exchange Online.
BackupSet	String	Name of the backup set.
BackupSetID	String	ID of the backup set.
DestinationID	String	ID of the backup destination.
DestinationName	String	Name of the backup destination.
DestinationType	String	Destination storage of the backup set. The value can be one of the following: Local/Mapped Drive/ Removable Drive:Local, Alibaba Cloud:Aliyun, CTYun:CTYun, Amazon S3:S3, AWS S3 Compatible Cloud Storage:AWSCompatible, Wasabi:Wasabi, Backblaze:Backblaze, Google Cloud Storage:GCS, Google Drive:GDrive, Microsoft Azure:Azure, OneDrive:OneDrive, OneDrive for Business:OneDrive4Biz, Rackspace:Rackspace, OpenStack:OpenStack, Dropbox:Dropbox, FTP:FTP, SFTP:SFTP, AhsayCBS:OBS and Destination pool:Pooled.
OverallPercent	String	Progress of the backup job shown in percentage.
BackupStatus	String	Message type of the current stage of backup job (Info/Warn/Error).
LastMessage	String	Last message reported during the backup job.
LastUpdateTime	String	Time of last message reported during the backup job.
EstimatedTimeLeft	String	Estimated time to backup job completion.
SizeLeft	String	Data size left to be backed up.
UploadedSize	String	Data size of all uploaded data during the backup job.
TransferRate	String	Transfer rate measured at the moment.
CurrentFile	String	Current backup / restore file.
UploadedNumOfFiles	String	Total number of files uploaded for BackupStatus (e.g. input "Type":"backup") or Total number of files downloaded for RestoreStatus (e.g. input "Type":"restore").
UploadedNumOfDirs	String	Total number of directories uploaded for BackupStatus (e.g. input "Type":"backup") or Total number of directories downloaded for RestoreStatus (e.g. input "Type":"restore").
UploadedNumOfLinks	String	Total number of links uploaded for BackupStatus (e.g. input "Type":"backup") or Total number of links downloaded for RestoreStatus (e.g. input "Type":"restore").
ElapsedTime	String	Elapsed time of the backup job.
CurrentFilePercent	String	Upload percentage of the current file being backed up / restored.
CurrentFileType	String	Type of file, which can be Full, Incremental or Differential.
CurrentFileOperation	String	File operation list. The value can be one of the following: new, update, delete, move or file permission.
DeltaFile	String	Delta file path.
DeltaFilePercent	String	Upload percentage of the current delta file.
DeltaType	String	Delta type, which can either be Incremental or Differential.
BackupJobID or RestoreJobID	String	Backup Job ID for BackupStatus (e.g. input "Type":"backup"), or Restore Job ID for RestoreStatus (e.g. input "Type":"restore"). ID in YYYY-MM-DD-hh-mm-ss format.

Examples

Example 1: If "Type" is "backup" ("Type":"backup")

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT

{
	"Status":"OK",
	"BkpStatus":[
		{
			"LoginName":"obm",
			"Owner":"",
			"ClientType":"OBM",
			"CurrentFileType":"",
			"UploadedNumOfLinks":"0",
			"ElapsedTime":"4 sec",
			"BackupSetID":"1687077919738",
			"DestinationType":"OBS",
			"CurrentFile":"",
			"TransferRate":"0bit/s",
			"LastMessage":"[1687077949198] Using Temporary Directory C:\\Users\’user’\\.obm\\temp\\1687077919738\\OBS@1687077949198",
			"UploadedSize":"0",
			"LastUpdateTime":"06/18/2024 16:46:03",
			"EstimatedTimeLeft":"0 sec",
			"DestinationName":"AhsayCBS",
			"BackupSet":"Backup Set Test (File Backup)",
			"SizeLeft":"0",
			"ID":"0",
			"DeltaFilePercent":"0",
			"DeltaType":"",
			"UploadedNumOfFiles":"0",
			"CurrentFileOperation":"",
			"BackupJobID":"2024-06-18-16-45-58",
			"DestinationID":"1687077949198",
			"OverallPercent":"0",
			"Type":"FILE",
			"CurrentFilePercent":"0",
			"UserID":"1686791459557",
			"Alias":"obm",
			"DeltaFile":"",
			"UploadedNumOfDirs":"0",
			"UserType":"PAID",
			"BackupStatus":"info"
		}
	]	
}

Example 2: If "Type" is "restore" ("Type":"restore")