This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Backup Job Session by Job ID

You can 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 parameter must be specified in the URL of the request:

Parameter	Type	Description
jobId	string	Specifies the identification number of the backup job. For more information on how to get this parameter, see Getting Backup Jobs.

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
offset	integer	Shows the offset value.
limit	integer	Shows the limit of records to be displayed on the page.
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	integer	Specifies the number of processed objects during the job session.
status	string	Specifies the status of the backup job: Stopped Running Success Warning Failed Disconnected NotConfigured Queued
statistics	jobStatistics	Specifies the job session statistics.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

jobStatistics

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.
transferredDataBytes	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: Source Target Detecting N/A

Examples

Example 1

The following request returns a resource representation of all job sessions created for a backup job with the 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"

}

...

],
"_links": {
"self": {
"href": "https://abc.tech.local:4443/v5/JobSessions?offset=0&limit=30"
},
"next": {
"href": "https://abc.tech.local:4443/v5/JobSessions?offset=30&limit=30"
}
}
}