| Warning |
|---|
| This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
The License Server Uptime endpoint delivers license usage metrics specific to license server status for the currently selected license server during any period the server status was monitored.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/uptime/server/${licenseServerId}/json?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD} |
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as follows:are described below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${licenseServerId} | Yes | integer | Specifies ID Internal License Statistics identification of the license server for which you want to view status information. |
| sd | Yes | string | Specifies starting Start date from for which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20. |
| ed | Yes | string | Specifies end End date from for which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20. The date is inclusive, meaning that all data from a particular day will be included in the report. |
The following code block shows an example result of a successful request.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"lsucd":${licenseServerUptimeCheckDateTime},
"lssid":${licenseServerStatusId},
"errid":${errorLogId}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows.
...
success
...
boolean
...
Indicates whether your API request was successfully processed.
...
string
...
Error message returned on failure.
...
lsucd
...
Date and time when License Statistics checked if license server was up.
...
lssid
...
integer
...
ID of license server status, which can be one of the following:
| ID | Status |
|---|---|
| 1 | UNKNOWN |
| 2 | UP |
| 3 | DOWN |
| 4 | INTERNAL ERROR |
| 5 | VERIFYING |
| 6 | DISABLED |
...
errid
...
integer
...
ID of the entry in the License Statistics error log.
...
Total number of all matching results.
This report supports only JSON format.
This report does not support standard options (filtering, limiting or ordering).
Response
On success, this report will contain one row for each event, such as query failure, server being disabled, successful query after period of failures, etc. See license server status descriptions for further details.
Each row consists of the following columns.
| Column | Full name | Type | Description |
|---|---|---|---|
lsucd | Time | date and time | Time when the event occurred. |
lssid | Status Id | integer | Numeric value of license server status. See license server status descriptions for further details. |
errmsg | Message | string | Optional message describing what went wrong. |
Example
The following example shows a command that obtains information about the Example
Say you would like to obtain information about uptime of license server "1" in January 2017. To generate this data set, enter a command similar to the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "sd=2017-01-01" --data "ed=2017-01-31" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json" |
Please keep in mind that you You can also put parameters directly into the URL;for example, to generate data for . For the above example, the command would look like thisthe following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json?sd=2017-01-01&ed=2017-01-31" |
Obtaining information about error messages
You can easily list error messages for any given log by sending the following HTTP request.
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/uptime/error/json?errid=${errorId} |
where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters can be explained as follows.
...
Specifies ID of the error log for which the error message should be retrieved.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: {
"errmsg": ${errorMessage}
},
code: ${code}
} |
where the response fields can be explained as follows.
...
boolean
...
Indicates that your API request was successfully processed.
...
string
...
License Statistics error message returned on failure.
...
string
...
The message you want to retrieve for a specific error log.
...
Error code for unsuccessful request.
...
Say you would like to view the message for error "1". To generate this data set, enter a command similar to the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "errid=1" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json" |
Similarly, as in the case of license server uptime, you can also put parameters directly in the URL; for example, to view the message for error "1", use a command similar to the one you can see below.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json?errid=1" |