API Gateway 10.11 | Administering API Gateway | Operating API Gateway | Data Management | Data Backup | Advanced Backup Options | Verifying Backup Status
 
Verifying Backup Status
When you run the create backup command, the backup process is initiated. You can then verify the status of a backup file using the status backup command. This command checks the status of a backup file and displays one of the following results:
Status
Description
Success
The backup file is successfully created with the given parameters.
Failed
The backup process has failed. You can diagnose the cause of failure using the -debug true parameter along with the create backup command or by checking the logs. For more information, see Troubleshooting a Failed Backup.
In progress
The backup process is still in progress. This message usually appears when the backup data is large and you verify the status as soon as you initiate the backup process.
Partial
The backup of the data is partially complete. You can troubleshoot such instances by following the steps given in Troubleshooting a Failed Backup.
Unavailable
The specified backup file does not exist. Verify the file name and repository.
*To verify the status of a backup
1. From the command prompt, go to SAGInstallDir/IntegrationServer/instances/default/packages/WmAPIGateway/cli/bin.
Note:
Replace default with the corresponding instance name.
2. Run the following command:
Linux
./apigatewayUtil.sh status backup -name backup-file-name
Windows
apigatewayUtil.bat status backup -name backup-file-name
The backup status appears as shown below:
C:\SoftwareAG\IntegrationServer\instances\default\packages\WmAPIGateway\cli\bin>apigatewayUtil.bat status backup -name
default-2021-april-12-11-38-4-420000000


The status of the default-2021-april-12-11-38-4-420000000 is SUCCESS
You can specify tenant and repository when verifying the backup status via the following parameters:
Parameter
Description
tenant
Name of the tenant that you want to verify backup status.
If you do not provide this parameter, the value is picked from pg.gateway.elasticsearch.tenantId property in config.properties file located at IntegrationServer\instances\instance_name\packages\WmAPIGateway\config\resources\elasticsearch.
repoName
Name of the repository where the backup can be found.
If you do not provide this parameter, the value is picked from the tenant parameter.
verbose
Option to display detailed status of the backup files in a given repository. Possible values are:
*true. The backup files appear with the following details:
*snapshot. Name of the backup file.
*status. Status of the backup process.
*startTime. Time when the backup process was initiated.
*endTime. Time when the backup process was completed.
*Duration. Time when for the backup creation.
*Indices. Name of the indexes included in the backup.
*Successful shards. Number of successful shards in backup.
*Failed shards. Number of failed shards in backup.
*Total shards. Number of successful shards in backup.
*false. The backup files appear without the details listed above.
When you do not provide this parameter, the value for the parameter is considered as false, the backup files appear without the list of details seen above.
format
Option to specify the format in which the details must appear. Works in combination with the verbose parameter. Available options are:
*JSON
*Text
For example, if you run the following command, the backup status details are displayed in plain text format:
apigatewayUtil.bat status backup -name
samplebackup -verbose true -format text
logLevel
Level of log that you want to create. Log levels indicate the severity of logs. Available levels are:
*Info. Provides the list of regular events that occur during the process. These events are informative.
*Debug. Provides the events that could be useful, if you have to debug the process.
*Warning. Indicates unexpected events that occurred during the process. Usually, these events do not interrupt or have an immediate effect on the process.
*Error. Indicates the events that stop the functionality from working as designed.
*Trace. Provides the list of events in a much detailed manner that could be useful for debugging.
You can specify one of the log level with the logLevel parameter. For example, to create a log file of Warning level when listing backup files, you can run the following command:
apigatewayUtil.bat list backup -logLevel warning
When you provide Error as the log level, then only the error level logs are saved. When you provide Debug as the log level, then Debug, Info, Warning and Error level logs are saved. When you provide Trace as log level, then all level logs are saved.
This parameter is optional. If you do not specify the parameter, then the Info level logs are saved by default.
logFileLocation
Location where you want to save the log file.
For example, to save the log file in C:/apiglogs/backups, you can provide the location as seen in the following example:
apigatewayUtil.bat create backup -name samplebackup
-logFileLocation C:/apiglogs/backups
This parameter is optional. If you do not specify the parameter, the logs are saved in the following location SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/logs/APIGWUtility.log
If you run the status backup command without the tenant and repoName parameters, then the given backup file is checked in the default tenant and repository.