ListBackupJobStatus

July 21, 2025

This API can be used to show detailed information such as destination ID and job status of all backup jobs performed by a specific user on a specific date.

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

  • Monitoring > Backup / Restore Logs > Backup Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListBackupJobStatus.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.
Owner String Sub admin username (if applicable).
LoginName String Username of the backup user.
BackupDate String Date of backup, in yyyy-MM-dd format.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array See Record.
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

Record

Key Type Description
ID String ID of the record.
LoginName String Name of the backup user.
Owner String Sub admin username (if user is owned by sub admin).
UserId String ID of the backup user.
StartTime String Time backup started, in yyyy-MM-dd format.
EndTime String Time backup finished, in yyyy-MM-dd format.
BackupJobStatus String Job status, BS_STOP_SUCCESS if backup is successful. The error varies if the backup failed.
BackupSetID String ID of the backup set.
BackupSetName String Name of the backup set.
UploadSize String Size of the upload.
RunVersion String Version where job was run.
SuccessDatabase String Database of successful jobs.
MissedDatabase String Database of missed 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 chosen destination.
Examples

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Owner":"",
	"LoginName":"ACB",
	"BackupDate":"2024-08-16"
}

OUTPUT

{
	"Status":"Error",
	"Data":[
		{
			"BackupJobStatus":"BS_STOP_BY_USER",
			"BackupSetName":"TEST 1",
			"LoginName":"ACB",
			"Owner":"",
			"MissedDatabase":"",
			"EndTime":"2024-28-16 14:06:33",
			"SuccessDatabase":"",
			"SuccessPublicFolder":"",
			"StartTime":"2024-08-16 14:06:18"
			"BackupSetID":"1692164297907",
			"MissedPublicFolder":"",
			"DestinationID":"1692164297907",
			"UserID":"ACB",
			"UploadSize":0,
			"RunVersion":"9.7.0.0",
			"ID":"2024-08-16-14-16-17
		}
	]
}
Documentation