GET /replicaTaskSessions/{ID}

Returns a resource representation of a replication task session having the specified ID.

Request

To get a replication task session having the specified ID, send the GET HTTP request to the URL of the /replicaTaskSessions/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/replicaTaskSessions/{ID}

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. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

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:

  • application/xml
  • application/json

Response Body

In the response body, the REST API returns an entity or an entity reference of the /replicaTaskSessions/{ID} resource. The resource entity contains the following parameters and links.

Parameters

Element

Type

Description

UID

UidType

UID of the replication task session.

Name

String

Name of the replication task session, for example: dc-hv@2013-08-25 05:01:09.

JobSessionUid

UidType

UID of the replication job session parent to the replication task session resource.

CreationTime

DateTime

Date and time when the replication task session was launched. The parameter accepts only UTC-formatted DateTime values.

EndTime

DateTime

Date and time when the replication task session was completed. The parameter accepts only UTC-formatted DateTime values.

State

String

State of the replication task session. Possible values:

  • InProgress
  • Pending
  • Completed

Result

String

Result of the replication task session. Possible values:

  • Success
  • Warning
  • Failed

Reason

String

Reason for which the replication task session has been completed with the Warning or Failed result.

TotalSize

Long

Size of all restore points produced by the replication job.

To view query parameters that you can use for filtering or sorting, see GET /query?type=ReplicaTaskSession.

Links

Reference

Relationship

Description

/backupServers/{ID}

Up

URL of the /backupServers/{ID} resource — a backup server where the parent replication job was configured.

/replicaSessions/{ID}

Up

URL of the /replicaSessions/{ID} resource — a parent replication job session.

/replicaTaskSessions/{ID}

Alternate

Alternate URL of the /replicaTaskSessions/{ID} resource.

Example

The example request below returns an entity resource representation of a task session having ID 809564f0-d2e7-4ee2-af2f-06d385138be2:

Request:

GET https://localhost:9398/api/replicaTaskSessions/809564f0-d2e7-4ee2-af2f-06d385138be2?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<?xml version="1.0" encoding="utf-8"?>
<ReplicaTaskSession xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://localhost:9398/api/replicaTaskSessions/809564f0-d2e7-4ee2-af2f-06d385138be2?format=Entity" Type="ReplicaTaskSession" Name="apache02_replica01@2021-10-17 20:00:27" UID="urn:veeam:ReplicaTaskSession:809564f0-d2e7-4ee2-af2f-06d385138be2" VmDisplayName="apache02_replica01" xmlns="http://www.veeam.com/ent/v1.0">
   <Links>
       <Link Href="https://localhost:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f" Name="enterprise01.tech.local" Type="BackupServerReference" Rel="Up" />
       <Link Href="https://localhost:9398/api/replicaSessions/3ae6d70c-e13f-4ee5-9da6-8920369ced66" Name="Replication Job 1@2021-10-17 20:00:11" Type="ReplicaJobSessionReference" Rel="Up" />
       <Link Href="https://localhost:9398/api/replicaTaskSessions/809564f0-d2e7-4ee2-af2f-06d385138be2" Name="apache02_replica01@2021-10-17 20:00:27" Type="ReplicaTaskSessionReference" Rel="Alternate" />
   </Links>
   <JobSessionUid>urn:veeam:ReplicaJobSession:3ae6d70c-e13f-4ee5-9da6-8920369ced66</JobSessionUid>
   <CreationTimeUTC>2021-10-17T20:00:27.087Z</CreationTimeUTC>
   <EndTimeUTC>2021-10-17T20:03:11.843Z</EndTimeUTC>
   <State>Completed</State>
   <Result>Success</Result>
   <Reason />
   <TotalSize>8589934592</TotalSize>
</ReplicaTaskSession>