Get Journal
Retrieves notification messages. For example, you can use this API to check if there are errors in the Usage Meter appliance (with a query param level=Err).
Request
URI
GET
https://{api_host}/um_journal
COPY
Query Parameters
integer
productId
Optional
The product ID to retrieve messages for, obtained from Add /product API response
integer
timeStart
Optional
Only include messages with timestamp greater than or equal to this one (in unix milliseconds)
integer
timeEnd
Optional
Only include messages with timestamp less than or equal to this one (in unix milliseconds)
Header Parameters
string
sessionid
Required
The authentication token obtained from login API response
Responses
200
OK
Returns Array of object of type(s) application/json
[
{
"code": "NSXV_COL_SUCCESS",
"productId": 5,
"data": "",
"level": "Info",
"journalId": 88,
"time": 1590613290448,
"message": "Successful collection",
"productType": "NSX-V",
"group": "NSXV_COL"
},
{
"code": "COLLECT_OK",
"productId": 19,
"data": "",
"level": "Info",
"journalId": 109,
"time": 1590627684716,
"message": "Successful collection",
"productType": "VCD",
"group": "VCD"
}
]
401
Returns 401Unauthorized_sessionID of type(s) application/json
{
"errCode": "GW_LOGIN_REQUIRED",
"errMessage": "Your session not found or already expired. Please login"
}string
errCode
Optional
errCode
string
errMessage
Optional
errMessage