Getting Backup Job Session by Job ID
This section explains how to get a resource representation of a collection of sessions created for the backup job with the specified ID.
Request
GET https://<hostname>:4443/v5/Jobs/{jobId}/JobSessions |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
|---|---|---|
jobId | string | An identification number of the backup job. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The /Jobs/{jobId}/JobSessions resource has the following properties:
Property | Type | Description |
|---|---|---|
Id | string | Specifies the ID of the job session. |
CreationTime | UTC | Specifies date and time when the job session was created. |
EndTime | UTC | Specifies date and time when the latest job session ended. |
Progress | int | Specifies the number of processed mailboxes during the job session. |
Status | string | Specifies the status of the backup job:
|
Statistics | Specifies the job session statistics. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Specifies the following job session statistics:
Property | Type | Description |
|---|---|---|
ProcessingRateBytesPS | string | Specifies the average speed of data processing. This counter is a ratio between the amount of data that has actually been read and job duration. The value is given in bytes per second. |
ProcessingRateItemsPS | string | Specifies the average speed of data processing. This counter is a ratio between the amount of data that has actually been read and job duration. The value is given in items per second. |
ReadRateBytesPS | string | Specifies the average speed of reading data from the backup repository. The value is given in bytes per second. |
WriteRateBytesPS | string | Specifies the average speed of writing data to the backup repository. The value is given in bytes per second. |
TransferredDataBytesPS | string | Specifies the amount of data transferred from the source-side to the target-side after applying compression and deduplication. The value is given in bytes per second. |
BottleNeck | string | Specifies the bottleneck in the data transmission process:
|
Example
The following request returns an entity representation of all job sessions created for a backup job with ID 196e4df2-0faf-4b8e-ba17-ce8c0eb4edc5.
Request: GET https://abc.tech.local:4443/v5/Jobs/196e4df2-0faf-4b8e-ba17-ce8c0eb4edc5/JobSessions
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "results": [ { "id": "6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1", "creationTime": "2020-12-13T22:00:00.5852401Z", "endTime": "2020-12-13T22:02:17.6515649Z", "progress": 18, "status": "Success", "statistics": { "processingRateBytesPS": 71012, "processingRateItemsPS": 9, "readRateBytesPS": 247870, "writeRateBytesPS": 2184, "transferredDataBytes": 63570500, "processedObjects": 377, "bottleneck": "Target" }, "_links": { "self": { "href": "https://abc.tech.local:4443/v5/jobsessions/6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1" }, "log": { "href": "https://abc.tech.local:4443/v5/jobsessions/6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1/logitems" }, "job": { "href": "https://abc.tech.local:4443/v5/jobs/196e4df2-0faf-4b8e-ba17-ce8c0eb4edc5" } } }, ... ], |
