Getting Backup Job Session by Session ID

In this article

    You can get a resource representation of a job session with the specified ID.

    Request

    GET https://<hostname>:4443/v5/JobSessions/{jobSessionsId}

    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

    jobSessionsId

    string

    An identification number of the backup session.

    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 /JobSessions/{jobSessionsId} 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

    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.

    processedObjects

    integer

    Specifies the number of mailbox items processed by the backup job.

    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 the job session with the ID a8cf9a63-64c3-4748-9c95-b1fbac0cce1d.

    Request:

    GET https://abc.tech.local:4443/v5/JobSessions/a8cf9a63-64c3-4748-9c95-b1fbac0cce1d

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

       "id": "a8cf9a63-64c3-4748-9c95-b1fbac0cce1d",

       "creationTime": "2019-02-04T16:49:22.8529769Z",

       "endTime": "2019-02-04T16:50:21.3024288Z",

       "progress": 1,

       "status": "Success",

       "statistics": {

         "processingRateBytesPS": 1683256,

         "processingRateItemsPS": 20,

         "readRateBytesPS": 5383429,

         "writeRateBytesPS": 26015396,

         "transferredDataBytes": 98142970,

         "processedObjects": 1193,

         "bottleneck": "Source"

       },

       "_links": {

         "self": {

           "href": "https://abc.tech.local:4443/v5/jobsessions/a8cf9a63-64c3-4748-9c95-b1fbac0cce1d"

         },

         "log": {

           "href": "https://abc.tech.local:4443/v5/jobsessions/a8cf9a63-64c3-4748-9c95-b1fbac0cce1d/log"

         },

         "job": {

           "href": "https://abc.tech.local:4443/v5/jobs/b20cedd4-66b2-49b1-86de-a575dc67e83b"

         }

       }

     }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.