GetBackupJobReportSummary

July 21, 2025

This API can be used to retrieve a summary report of a backup job.

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/GetBackupJobReportSummary.do

Available Since Version: 9.7

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
Owner String Owner of the backup user.
BackupSetID String ID of the backup set. Obtainable by calling the GetBackupSet API.
DestinationID String For backup run by AhsayOBM v6 or older, this parameter can be omitted. For backup run by AhsayOBM v7, this parameter must be provided to get correct result.
BackupJobID String ID of the backup job. Obtainable by calling the GetBackupSet API.
Cdp Boolean True / False
Return Values
Key Type Description
Status String "OK" or "Error"
Data String See JSON Objects
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, it appears only if status is "Error".
JSON Objects

Report

Key Type Description
ID String ID of the report.
StartTime String In yyyy-MM-dd HH:mm:ss format.
EndTime String In yyyy-MM-dd HH:mm:ss format.
BackupJobStatus String Job status. BS_STOP_SUCCESS if successful backup. Error varies if the backup failed.
NumOfWarnEntries Long Number of warning entries.
NumOfErrorEntries Long Number of error entries.
NumOfNewFiles Long Number of new files.
TotalNewFilesSize Long Total size of new files.
NumOfUpdatedFiles Long Number of updated files.
TotalUpdatedFilesSize Long Total size of updated files.
NumOfDeletedFiles Long Number of deleted files.
TotalDeletedFilesSize Long Total size of deleted files.
NumOfMovedFiles Long Number of moved files.
TotalMovedFilesSize Long Total size of moved files.
NumOfUpdatedPermissionFiles Long Number of updated permission files.
TotalUpdatedPermissionFilesSize Long Total size of updated permission files.
SuccessDatabase Long This key does not exist in VM backup.
MissedDatabase Long This key does not exist in VM backup.
SuccessVirtualMachine Long This key exists in VM backup.
MissedVirtualMachine Long This key exists in VM backup.
SuccessPublicFolder Long Public folder of successful jobs.
MissedPublicFolder Long Public folder of missed jobs.
DedupeEnabled Boolean Whether deduplication is enabled or not.
DedupeOriginalSize Long Size of deduplication.
DedupeSaving Long Difference between the original size of dedupe and current dedupe size.
Example

INPUT 

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"BackupJobID":"2024-06-26-13-24-35",
	"DestinationID":"1687755083984"
}

OUTPUT 

{
	"Status":"OK",
	"Data":{
		"TotalCopiedSize":0,
		"DedupeEnabled":true,
		"DedupeOriginalSize":2384,
		"DedupeSaving":0,
		"EndTime":"2024-08-23 10:00:59",
		"TotalDeletedFilesSize":0,
		"NumOfMovedFiles":0,
		"SuccessPublicFolder":"",
		"TotalUpdatedFilesSize":726,
		"TotalUpdatedPermissionFilesSize":0,
		"NumOfWarnEntries":0,
		"NumOfNewFiles":0,
		"NumOfUpdatedFiles":1,
		"NumOfCopiedFiles":0,
		"ID":"2024-08-23-10-00-36",
		"NumOfErrorEntries":0,
		"BackupJobStatus":"BS_STOP_SUCCESS",
		"TotalNewFilesSize":0,
		"MissedDatabase":"",
		"NumOfUpdatedPermissionFiles":0,
		"SuccessDatabase":"",
		"StartTime":"2024-08-23 10:00:37",
		"NumOfDeletedFiles":0,
		"MissedPublicFolder":"",
		"TotalMovedFilesSize":0
	}
}
Documentation