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

Getting Logs by Session ID

This section explains how to get logs for the specified session.

Request

GET https://<hostname>/api/v1/jobSessions/{sessionId}/log

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	Description
sessionId	The identification number of the session. Can be obtained as described in Getting Sessions.

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

Property	Type	Description
jobSessionId	string	Shows the identification number of the session.
log	LogItem Object	Contains information about logs.

LogItem Object

Property	Type	Description
logTime	string	Shows the time when the log was obtained.
status	string	Shows the status of the operation.
message	string	Shows the message.
executionStartTime	string	Shows the time when the session was initiated.
executionDuration	string	Shows the duration of the session.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/38/log

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"jobSessionId": "38",

"log": [

{

"logTime": "2020-02-05T10:43:57.039827Z",

"status": "Success",

"message": "Backup plan creation has finished",

"executionStartTime": "2020-02-05T10:43:57.039845Z",

"executionDuration": "00:02:33.8496840"

{

"logTime": "2020-02-05T10:46:30.897649Z",

"status": "Success",

"message": "Snapshot backup of 'tw-vm2' has finished",

"executionStartTime": "2020-02-05T10:46:30.897721Z",

"executionDuration": "00:02:09.7753450"

{

"logTime": "2020-02-05T10:48:40.67325Z",

"status": "Success",

"message": "Repository backup of 'tw-vm2' has finished",

"executionStartTime": "2020-02-05T10:48:40.67461Z",

"executionDuration": "00:02:52.9666850"

{

"logTime": "2020-02-05T10:51:33.641329Z",

"status": "Success",

"message": "Snapshot retention of 'tw-vm2' has finished: removed 1 restore point (127 GB).",

"executionStartTime": "2020-02-05T10:51:33.646789Z",

"executionDuration": "00:00:01.4468860"

}

]

}