This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /replicaTaskSessions/{ID}
Returns a resource representation of a task having the specified ID. The parent replication job for the task is created and run on the Veeam backup server connected to Veeam Backup Enterprise Manager.
Request
To get a task having the specified ID, you need to send the GET HTTP request to the URL of the /replicaTaskSessions/{ID} resource.
HTTP Request
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
UID | URN | ID of the replica task session. | True | True |
Name | String | Name of the replica task session, for example: dc-hv@2013-08-25 05:01:09. | True | True |
CreationTime | DateTime | Date and time when the replica task session was launched. The parameter accepts only UTC-formatted DateTime values. | True | True |
EndTime | DateTime | Date and time when the replica task session was completed. The parameter accepts only UTC-formatted DateTime values. | True | True |
State | String | State of the replica task session. Possible values:
| True | True |
Result | String | Result of the replica task session. Possible values:
| True | True |
Reason | String | Reason for which the replica task session has been completed with the Warning or Failed result. | True | True |
TotalSize | Long | Size of all restore points produced by the corresponding replication job. | True | True |
JobSessionUid | URN | ID of the replication job session parent to the replica task session resource. | True | True |
JobUid | URN | ID of the replication job parent to the replica task session resource. | True | True |
JobName | String | Name of the replication job parent to the replica task session resource. | True | True |
BackupServerUid | URN | ID of the backup server on which the corresponding replication job is created. | True | True |
BackupServerName | String | Name of the backup server on which the corresponding replication job is created. | True | True |
VmDisplayName | String | Name of the VM that is processed in the replica task session. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /replicaTaskSessions/{ID} resource.
Example
The example request below returns a resource representation of a task having ID 4a212394-ea3b-420d-b1d0-04dbf9f6c622:
Request: GET https://localhost:9398/api/replicaTaskSessions/4a212394-ea3b-420d-b1d0-04dbf9f6c622
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: |
