ListRestoreJobStatus

July 21, 2025

This API can be used to list restore job status of a specified user on a particular date.

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

  • Monitoring > Backup / Restore Logs > Restore Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListRestoreJobStatus.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
SysPwd String Password matching SysUser.
Owner String Owner of the backup user account, usually the sub-admin (if applicable).
LoginName String Username of the backup user.
RestoreDate String Date of restore job, in yyyy-MM-dd format.
Return Values
Key Type Description
Status String "OK" or "Error"
Data JSON Object See Data.
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

Data

Key Type Description
ID String ID of the restore job.
LoginName String Name of the backup user.
Owner String Owner of the backup user account, usually the sub-admin (if applicable).
UserID String ID of the backup user.
StartTime String Time restore job started, in yyyy-mm-dd-HH-mm-ss format.
EndTime String Time restore job ended, in yyyy-mm-dd-HH-mm-ss format.
RestoreJobStatus String Job status. RESTORE_STOP_SUCCESS if the restore is successful. Error varies if the restore failed.
BackupSetID String ID of the backup set.
BackupSetName Boolean Name of the backup set.
RestoreSize String Size after restore.
RunVersion String Client version that ran the restore job.
SuccessDatabase String Database of successful restore jobs.
MissedDatabase String Database of missed restore jobs.
SuccessVirtualMachine String If backup is VM type, SuccessPublicFolder is returned instead.
MissedVirtualMachine String If backup is VM type, MissedPublicFolder is returned instead.
SuccessPublicFolder String Only returned if backup is VM type.
MissedPublicFolder String Only returned if backup is VM type.
DestinationID String ID of the destination.
Examples

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"RestoreDate":"2024-06-26"
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"Status":"RESTORE_STOP_SUCCESS",
			"BackupSetName":"default-backup-set-name-1",
			"LoginName":"obm",
			"Owner":"",
			"EndTime":"2024-06-26 13:25:21",
			"UserId":"obm",
			"RunVersion":"9.11.0.0",
			"StartTime":"2024-06-26 13:25:14",
			"ID":"2024-06-26-13-25-13",
			"BackupSetID":"1687755057644",
			"RestoreSize":0,
			"DestinationID":"1687755083984"
		}
	]
}
Documentation