GET /cdpReplicaTaskSessions/{ID}

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

Request

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

HTTP Request

GET https://<Enterprise-Manager>:9398/api/cdpReplicaTaskSessions/{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, Veeam Backup Enterprise Manager returns an entity or an entity reference of the /cdpReplicaTaskSessions/{ID} resource. The resource entity contains the following parameters and links.

Parameters

Element

Type

Description

UID

UidType

UID of the CDP replication task session, for example: urn:veeam:CdpReplicaTaskSession:ad86fed0-4288-47ba-a7ab-0fca64d3ba5a.

Name

String

Name of the CDP replication task session, for example: virt03-ubuntu01@2021-02-12 00:00:10.

PolicySessionUid

UidType

UID of the CDP policy session parent to the CDP replication task session resource, for example: urn:veeam:CdpReplicaSession:6b872a71-51e8-437a-8d45-5c6494b92f3f.

CreationTimeUTC

DateTime

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

EndTimeUTC

DateTime

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

State

String

State of the CDP replication task session. Possible values:

  • InProgress
  • Pending
  • Completed

Result

String

Result of the CDP replication task session. Possible values:

  • Success
  • Warning
  • Failed

Reason

String

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

TotalSize

Long

Size of all restore points produced by the CDP replication task session.

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

Links

Reference

Relationship

Description

/backupServers/{ID}

Up

URL of the /backupServers/{ID} resource — a backup server where the CDP policy was configured.

/cdpReplicaSessions/{ID}

Up

URL of the /cdpReplicaSessions/{ID} resource — a parent CDP replication session.

/cdpReplicaTaskSessions/{ID}

Alternate

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

Example

The example request below returns an entity resource representation of a CDP replication task session having ID 2ec4d35f-b5d8-4cb3-9d11-12e1d5792625:

Request:

GET https://localhost:9398/api/cdpReplicaTaskSessions/2ec4d35f-b5d8-4cb3-9d11-12e1d5792625?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<CdpReplicaTaskSession xmlns="http://www.veeam.com/ent/v1.0" Type="CdpReplicaTaskSession" Href="https://localhost:9398/api/replicaTaskSessions/2ec4d35f-b5d8-4cb3-9d11-12e1d5792625?format=Entity" Name="virt03-ubuntu01@2021-02-12 00:00:10" UID="urn:veeam:CdpReplicaTaskSession:2ec4d35f-b5d8-4cb3-9d11-12e1d5792625" VmDisplayName="virt03-ubuntu01">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/cca0b96b-4924-4461-8899-b831bc00176e" Name="enterprise03.tech.local" />
   <Link Rel="Up" Type="CdpReplicaSessionReference" Href="https://localhost:9398/api/cdpReplicaSessions/6b872a71-51e8-437a-8d45-5c6494b92f3f" Name="CDP Policy 1@2021-02-11 19:08:36" />
   <Link Rel="Alternate" Type="CdpReplicaTaskSessionReference" Href="https://localhost:9398/api/cdpReplicaTaskSessions/2ec4d35f-b5d8-4cb3-9d11-12e1d5792625" Name="virt03-ubuntu01@2021-02-12 00:00:10" />
 </Links>
 <PolicySessionUid>urn:veeam:CdpReplicaSession:6b872a71-51e8-437a-8d45-5c6494b92f3f</PolicySessionUid>
 <CreationTimeUTC>2021-02-12T00:00:10.457Z</CreationTimeUTC>
 <State>InProgress</State>
 <Result>Success</Result>
 <TotalSize>17179869184</TotalSize>
</CdpReplicaTaskSession>