Overview | Service | Command |
Backup Query
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<BackupQueryRequest> ## BackupQueryRequest
<query [target="{path-to-backup-target}"] [label="{backup-set-label}"] [type="{backup-type}"]
[from="{start-time-millis} (Long)"] [to="{end-time-millis} (Long)"] [stats="{show-stats} (0|1)"]
[backupListOffset="{backup-list-offset} (Integer)"] [backupListCount="{backup-list-count} (Integer)"]
[accountListStatus="{account-list-status-filter}"] [accountListOffset="{account-list-offset} (Integer)"]
[accountListCount="{account-list-count} (Integer)"] /> ## BackupQuerySpec
</BackupQueryRequest>
The following table describes elements and attributes you can define within a
<BackupQueryRequest>
element:
XPath | Required / Optional | Description |
/query | Required (only 1) | Query |
/query@target | Optional (0 or 1) | Type:String Path to backup target |
/query@label | Optional (0 or 1) | Type:String Backup set label |
/query@type | Optional (0 or 1) | Type:String Backup type - full|incremental |
/query@from | Optional (0 or 1) | Type:Long Return backups whose start time is at or after this time. Defaults to beginning of time if not specified |
/query@to | Optional (0 or 1) | Type:Long Return backups whose end time is at or before this time. Defaults to end of time if not specified |
/query@stats | Optional (0 or 1) | Type:0|1 Statistics will be included in the response if this is set |
/query@backupListOffset | Optional (0 or 1) | Type:Integer Backup list offset. Used in backup list pagination. Default = 0 |
/query@backupListCount | Optional (0 or 1) | Type:Integer Backup list count. Used in backup list pagination. Default = -1, meaning all |
/query@accountListStatus | Optional (0 or 1) | Type:String Use this to filter the account list by backup status. Values: NONE | ALL | COMPLETED | ERROR | NOTSTARTED | INPROGRESS Default: NONE |
/query@accountListOffset | Optional (0 or 1) | Type:Integer Account list offset. Used in account list pagination. Default = 0 |
/query@accountListCount | Optional (0 or 1) | Type:Integer Account list count. Used in account list pagination. Default = -1, meaning all |
<BackupQueryResponse totalSpace="{total-space-bytes} (long)" freeSpace="{free-space-bytes} (long)"
[more="{more-backups} (0|1)"]> ## BackupQueryResponse
(<backup [label="{backup-set-label}"] [type="{backup-type}"] [aborted="{aborted-flag} (0|1)"]
[start="{start-time-millis} (Long)"] [end="{end-time-millis} (Long)"]
[minRedoSeq="{min-redo-seq} (Long)"] [maxRedoSeq="{max-redo-seq} (Long)"]
[live="{live-backup-in-progress} (0|1)"]> ## BackupQueryInfo
<currentAccounts [total="{current-acct-total} (Integer)"]> ## CurrentAccounts
(<account name="{name}" /> ## Name)*
</currentAccounts>
<accounts [total="{total-accts-in-backup-set} (Integer)"]
[completionCount="{num-accts-whose-backups-completed-successfully} (Integer)"]
[errorCount="{num-accts-with-errors} (Integer)"] [more="{more-flag} (0|1)"]> ## BackupQueryAccounts
(<account name="{account-email}" status="{status}" [errorMessage="{error-message}"]>{trace}</account> ## BackupQueryAccountStatus)*
</accounts>
(<error [errorMessage="{error-message}"]>{trace}</error> ## BackupQueryError)*
<stats>
(<counter name="{counter-name}" unit="{counter-unit}" sum="{counter-value} (Long)"
numSamples="{num-samples-or-data-points} (Long)" /> ## BackupQueryCounter)*
</stats>
</backup>)*
</BackupQueryResponse>
The following table describes elements and attributes you can define within a
<BackupQueryResponse>
element:
XPath | Required / Optional | Description |
@totalSpace | Required (only 1) | Type:long total space on the backup target volume in bytes |
@freeSpace | Required (only 1) | Type:long Free space on the backup target volume in bytes |
@more | Optional (0 or 1) | Type:0|1 Present with value 1 (true) there are more backups to page through |
/backup | Optional (0 or more) | Backup information |
/backup@label | Optional (0 or 1) | Type:String Backup set label |
/backup@type | Optional (0 or 1) | Type:String Backup type - full|incremental |
/backup@aborted | Optional (0 or 1) | Type:0|1 Set if backup was aborted by the abort command |
/backup@start | Optional (0 or 1) | Type:Long Start time in milliseconds |
/backup@end | Optional (0 or 1) | Type:Long End time in milliseconds. Omitted for a live backup |
/backup@minRedoSeq | Optional (0 or 1) | Type:Long Minimum redo sequence in this backup set |
/backup@maxRedoSeq | Optional (0 or 1) | Type:Long Maximum redo sequence in this backup set |
/backup@live | Optional (0 or 1) | Type:0|1 "live" means backup is currently in progress |
/backup/currentAccounts | Optional (0 or 1) | Information about current accounts. <currentAccounts> is returned only for a live backup. |
/backup/currentAccounts@total | Optional (0 or 1) | Type:Integer Total number of accounts currently being backed up |
/backup/currentAccounts/account | Optional (0 or more) | Information on accounts |
/backup/currentAccounts/account@name | Required (only 1) | Type:String Name |
/backup/accounts | Optional (0 or 1) | Backup information by account |
/backup/accounts@total | Optional (0 or 1) | Type:Integer Total number of accounts in backup set |
/backup/accounts@completionCount | Optional (0 or 1) | Type:Integer Number of accounts whose backup completed successfully |
/backup/accounts@errorCount | Optional (0 or 1) | Type:Integer Number of accounts that had error during backup |
/backup/accounts@more | Optional (0 or 1) | Type:0|1 Present if there are more accounts to page through |
/backup/accounts/account | Optional (0 or more) | Type:{trace} Account list returned if request specified accountListStatus Description for element text content:Error stack trace, if available |
/backup/accounts/account@name | Required (only 1) | Type:String Account email |
/backup/accounts/account@status | Required (only 1) | Type:String Status - NOTSTARTED|INPROGRESS|COMPLETED|ERROR |
/backup/accounts/account@errorMessage | Optional (0 or 1) | Type:String Error message |
/backup/error | Optional (0 or more) | Type:{trace} Any errors that are not account-specific; account-specific errors are returned in <account>. Description for element text content:Error stack trace, if available |
/backup/error@errorMessage | Optional (0 or 1) | Type:String Error message |
/backup/stats | Required (only 1) | |
/backup/stats/counter | Optional (0 or more) | |
/backup/stats/counter@name | Required (only 1) | Type:String Counter name |
/backup/stats/counter@unit | Required (only 1) | Type:String Counter unit |
/backup/stats/counter@sum | Required (only 1) | Type:Long Counter value |
/backup/stats/counter@numSamples | Required (only 1) | Type:Long Number of samples or data points |