Software AG Products 10.11 | Administrating API Gateway | Operating API Gateway | Data Management | Data Backup | Advanced Backup Options | Viewing Backup Files List
 
Viewing Backup Files List
You can view the list of backup files in a location using the list backup command.
*To view the list of backup files
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 list backup
Windows
apigatewayUtil.bat list backup
The available list of backup files appears as follows:
C:\SoftwareAG\IntegrationServer\instances\default\packages\WmAPIGateway\cli\bin>apigatewayUtil.bat list backup

Backups available in default are

default-2021-april-12-11-38-4-420000000
sample
backup12april-analytics
default-2021-april-12-16-49-30-247000000
default-2021-may-17-22-23-2-266000000
default-2021-may-17-22-24-53-611000000
You can provide the following parameters based on your requirement:
Parameter
Description
tenant
Name of the tenant for which you want to view the list of backup files.
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 for which you want to view the list of backup files.
If you do not provide this value when running the list command, then the value is picked from the tenant parameter and the list of backup files from that repository appears.
status
Option to specify the status of backup files and filter backup files based on their status. For example, if you want to view the list of backup files whose status is Partial, then you can run the command as seen here:
apigatewayUtil.bat list backup -status partial
For information on possible states of backup files, see Verifying Backup Status.
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 taken 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. Total number of 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.