This operation runs a backup job for a backup set.
Request
Syntax
Send the request using either the ID or the name:
-
ID
POST <webservice>/Backupset/{backupsetId}/action/backup HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml -
Name
POST <webservice>/Backupset/byName(clientName='{clientName}',appName='{appName}',backupsetName='{backupsetName}')/action/backup HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|
backupsetId |
The backup set ID for the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it. |
Yes-for the request by ID |
|
clientName |
The client name for the backup set. If the client name is not known, use the GET Client API to retrieve it. |
Yes-for the request by name |
|
appName |
The application name for the backup set. If the application name is not known, use the GET Backup Set API to retrieve it. |
Yes-for the request by name |
|
backupsetName |
The backup set name of the backup set. If the backup set name is not known, use the GET Backup Set API to retrieve it. |
Yes-for the request by name |
Request Headers
|
Name |
Description |
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
taskId |
The system-generated ID assigned to the task. |
TMMsg_CreateTaskResp |
|
val |
The system-generated ID assigned to the job. |
jobIds |
Examples
Sample Request
This request uses the ID.
POST <webservice>/Backupset/3/action/backup HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
This request uses the name.
POST <webservice>/Backupset/byName(clientName='client001',appName='file system',backupsetName='defaultBackupSet')/action/backup HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
Sample Response
This is the response when the backup job for the backup set starts.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_CreateTaskResp taskId="77">
<jobIds val="920"/>
<jobIds val="921"/>
<jobIds val="922"/>
</TMMsg_CreateTaskResp>
This is the response when a backup job is requested for a backup set that does not exist.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GenericResp errorCode="587204050" errorMessage="Failed to run task. No associations exist."/>