GetRestoreDrillJobReportSummary

July 21, 2025

This API can be used to display the summary of specified restore drill job.

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

  • Monitoring > Backup / Restore Logs > Restore Drill Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetRestoreDrillJobReportSummary.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.
LoginName String Username of the backup user.
JobID String ID of the restore drill job in timestamp format (yyyy-MM-dd-HH-mm-ss). Obtainable by calling the ListRestoreDrillJobs API.
BackupSetID String ID of the backup set. Obtainable by calling the ListRestoreDrillJobs API.
DestinationID String ID of the destination. Obtainable by calling the ListRestoreDrillJobs API.
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, it appears only if status is "Error".
JSON Objects

Data

Key Type Description
Status String Status of the restore drill job. SUCCESS if restore drill is successful otherwise error message varies if the restore drill failed.
BackupSetID String ID of the backup set.
DestinationID String ID of the destination.
StartTime Long Start time of the restore drill job in millisecond time format.
EndTime Long End time of the restore drill job in millisecond time format.
LastBackupRun String Date and time when last backup was run, in yyyy-MM-dd-HH-mm-ss format.
RunOnClient Boolean Whether backup set is run on client or not.
TotalChunkSize Long Size of total data chunks, in bytes.
TotalChunkCount Long Number of total data chunks.
ValidChunkSize Long Size of data chunks in valid status, in bytes.
ValidChunkCount Long Number of data chunks in valid status.
CorruptedChunkSize Long Size of corrupted data chunks, in bytes.
CorruptedChunkCount Long Number of corrupted data chunks.
ToBeVerifiedChunkSize Long Size of data chunks in unknown status, in bytes.
ToBeVerifiedChunkCount Long Number of data chunks in unknown status.
LogoPath String Path for logo used in PDF reports.
Footer String Footer in PDF reports.
Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1686639360356",
	"DestinationID":"1697505829484",
	"JobID":"2024-10-17-09-32-47"
}

OUTPUT

{
	"Status":"OK",
	"Data":{
		"Status":"INVALID_DETECTED",
		"ValidChunkSize":491185025,
		"LogoPath":"D:\\AhsayCBS\\webapps\\cbs\\images\\default.large.gif",
		"EndTime":1697506377112,
		"LastBackupRun":"2024-10-17-09-24-12",
		"StartTime":1697506367000,
		"CorruptedChunkCount":120,
		"BackupSetID":"1697505782921",
		"TotalChunkCount":1913,
		"DestinationID":"1697505829484",
		"RunOnClient":false,
		"ValidChunkCount":1793,
		"ToBeVerifiedChunkSize":0,
		"CorruptedChunkSize":33432652,
		"ToBeVerifiedChunkCount":0,
		"Footer":"1999-2024 (C) Ahsay Systems Corporation All rights reserved.",
		"TotalChunkSize":524617677
	}
}

Example 2: Incorrect Destination ID / Backup Set ID

INPUT 

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1686639360356",
	"DestinationID":"xxxx",
	"JobID":"2024-10-17-09-32-47"
}

OUTPUT 

{
	"Status":"Erro",
	"Message":"[Error] Restore drill job not found.",
	"ExptType":"java.lang.Exception"
}
Documentation