This operation runs an ad-hoc backup job on the content group for object storage data.
Request
Syntax
POST /post HTTP/1.1
Host: <host name with endpoint>
Accept: application/xml or application/json
Authtoken: <authentication token>
Content-Type: application/xml or application/jsonRequest Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request along with the Web Console endpoint to which API requests must be submitted. For example, https://m6.metallic.io/webconsole/api/CreateTask |
|
Accept |
The format of the response. Valid values are: application/json. |
|
Authtoken |
The authentication token received after successfully logging on to Metallic. The QSDK token for authorization fetched using Login POST API call, see REST API - Authentication: POST Login. |
|
Content-Type |
The media type contained in the request body. |
Request Body
Download the XML file required for this request: <run_ad_hoc_backup_object_storage.xml> to run an ad-hoc backup for object storage data. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
Parent Element |
|---|---|---|---|
|
clientName |
The name of the object storage client. |
associations |
taskInfo |
|
instanceName |
The name of the object storage client. |
associations |
taskInfo |
|
subclientName |
The name of the content group. |
associations |
taskInfo |
|
storagePolicyName |
The name of the plan for backups. |
storagePolicy |
mediaOpt |
|
adHocBackup |
Flag to enable ad-hoc backups. Valid values are 'true' and 'false'. |
backupOpts |
options |
|
onDemandInputFile |
The path to the ad-hoc backup directive file. |
backupOpts |
options |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
taskId |
The system-generated ID assigned to the task. |
TMMsg_CreateTaskResp |
|
jobId |
The system-generated ID assigned to the job. |
jobIds |
Examples
Sample Request
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_CreateTaskReq> <processinginstructioninfo/> <taskInfo> <task> <taskFlags> <disabled>false</disabled> <isEdgeDrive>false</isEdgeDrive> </taskFlags> <policyType>DATA_PROTECTION</policyType> <taskType>IMMEDIATE</taskType> <initiatedFrom>COMMANDLINE</initiatedFrom> </task> <associations> <subclientName>stestgroup</subclientName> <backupsetName>defaultBackupSet</backupsetName> <instanceName>s-adhoc-object-storage</instanceName> <appName>Cloud Apps</appName> <clientName>s-adhoc-object-storage</clientName> </associations> <subTasks> <subTask> <subTaskType>BACKUP</subTaskType> <operationType>BACKUP</operationType> </subTask> <options> <backupOpts> <backupLevel>INCREMENTAL</backupLevel> <mediaOpt> <storagePolicy> <storagePolicyName>default-plan</storagePolicyName> </storagePolicy> </mediaOpt> <dataOpt> <createNewIndex>false</createNewIndex> <followMountPoints>true</followMountPoints> <useCatalogServer>false</useCatalogServer> <enforceTransactionLogUsage>false</enforceTransactionLogUsage> <skipConsistencyCheck>false</skipConsistencyCheck> <skipCatalogPhaseForSnapBackup>true</skipCatalogPhaseForSnapBackup> </dataOpt> <dbBackupOptions> <maxDbBackupType>UNKNOWN</maxDbBackupType> </dbBackupOptions> <runIncrementalBackup>false</runIncrementalBackup> <incLevel>BEFORE_SYNTH</incLevel> <doNotTruncateLog>false</doNotTruncateLog> <sybaseSkipFullafterLogBkp>false</sybaseSkipFullafterLogBkp> <truncateLogsOnSource>false</truncateLogsOnSource> <notSynthesizeFullFromPrevBackup>false</notSynthesizeFullFromPrevBackup> <adHocBackup>true</adHocBackup> <onDemandInputFile>/sk/s-directive-file-blob.txt</onDemandInputFile> </backupOpts> <restoreOptions> <virtualServerRstOption> <isBlockLevelReplication>false</isBlockLevelReplication> </virtualServerRstOption> </restoreOptions> <adminOpts> <contentIndexingOption> <subClientBasedAnalytics>false</subClientBasedAnalytics> </contentIndexingOption> </adminOpts> <commonOpts> <perfJobOpts/> <notifyUserOnJobCompletion>false</notifyUserOnJobCompletion> </commonOpts> </options> <subTaskOperation>OVERWRITE</subTaskOperation> </subTasks> </taskInfo>
</TMMsg_CreateTaskReq>Sample Response
This is the response when the request is successful
<TMMsg_CreateTaskResp taskId="4038"> <jobIds val="5976" />
</TMMsg_CreateTaskResp>This is a sample response when the request is not successful.
<TMMsg_GenericResp errorMessage="Failed to start backups as no eligible subclients were found. " errorCode="587207178" />