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 With License Statistics API, you can easily generate information about license server uptime, i.e. statistics about license server status for any license server during any period the server status was monitored.
Obtaining information about license server status
If you want to retrieve information You can easily fetch metrics about license server status history, we recommend that you use by sending the following URL HTTP request template.
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 proper value, according to your needs
- the value that best suits your needs. The possible parameters are as follows:described below.
Parameter | Required | Type | Description |
---|---|---|---|
${licenseServerId} | Yes | integer |
Specifies id of the feature which will be the subject of the report.
Internal License Statistics identification of the license server for which you want to view |
status information. | ||
sd | Yes | string |
Specifies starting date from which you want to generate the report. The date and time format is as follows: YYYY-MM-DD, for example, 2015-01-20.
Start date for which you want to generate the report. |
ed | Yes | string |
End date |
for which you want to generate the report. |
Specifies end date from which you want to generate the report. The date and time format is YYYY-MM-DD; for example, 2017-01-20. The date is inclusive, meaning that all data from a particular day will be included in the report.
If your request is successful, you should see a response similar to the following:
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 the 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 error log.
ID of the entry in the License Statistics error log.
...
Error code if success == false
Error code for unsuccessful request.?
...
Count of all matching results.
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 uptime of license server "1" in January 2017. Example
Say you would like to view information about uptime of license server 1 in January of 2015. To generate such data, enter a command similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "sd=20152017-01-01" --data "ed=20152017-01-31" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json" |
Keep in mind that you can also put parameters directly in the URL, e.g. for an equivalent of the above:
Keep in mind that you You can also put parameters directly into the URL,e.g. to generate data for . For the above example, the command would look like this:the following.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json?sd=20152017-01-01&ed=2015-01-31" |
Obtaining information about error messages
If you want to retrieve information about error message of any given log, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/uptime/error/json?errid=${errorId} |
where:
- $ indicates a variable value that you can replace with a proper value, according to your needs
- possible parameters are 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 whether the API request was successfully processed.
...
string
...
License Statistics error message returned on failure.
...
string
...
Requested message for the error log.
The message you want to generate for a specific error log.?
...
Error code if success == false
Error code for unsuccessful request.?
...
For example, say you would like to know what was message of error 1. To generate such data, enter a command that is 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, f.e for an equivalent of the above:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json?errid=12017-01-31" |