License Statistics API lets you generate data from the License Server Uptime report. This report shows 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 about license server status history, we recommend that you use the following URL request template.
GET /api/v1/report/uptime/server/${licenseServerId}/json?sd=${startDate}&ed=${endDate}
where:
- $ indicates a variable value that you can replace with an appropriate value, as needed
- possible parameters are as follows:
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${licenseServerId} | Yes | integer | Specifies id of the feature which will be the subject of the report. |
| 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. |
| ed | Yes | string | Specifies end date from which you want to generate the report. Date format as above. Date is inclusive, meaning all data from the particular day will be included in the report. |
If your request is successful, you should see a response similar to the following:
{
success: ${success},
msg: ${message},
data: [{
"lsucd":${licenseServerUptimeCheckDateTime},
"lssid":${licenseServerStatusId},
"errid":${errorLogId}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
}
where the response fields can be explained as follows:
| Field | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
success | boolean | Indicates if the API request was successfully processed. | ||||||||||||||
| msg | string | Error message returned on failure. | ||||||||||||||
lsucd | string | Date and time when License Statistics checked if license server was up. | ||||||||||||||
lssid | integer | Id of license server status. Can be one of the following:
| ||||||||||||||
errid | integer | Id of error log | ||||||||||||||
| code | integer | Error code if success == false | ||||||||||||||
| totalCount | integer | Count of all matching results. |
Example
For 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 that is similar to the following:
curl --data "sd=2015-01-01" --data "ed=2015-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:
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json?sd=2015-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.
GET /api/v1/report/uptime/error/json?errid=${errorId}
where:
- $ indicates a variable value that you can replace with an appropriate value, as needed
- possible parameters are as follows:
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${errorId} | Yes | integer | Specifies id of error log, for which message should be retrieved. |
If your request is successful, you should see a response similar to the following:
{
success: ${success},
msg: ${message},
data: {
"errmsg": ${errorMessage}
},
code: ${code}
}
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the API request was successfully processed. |
| msg | string | License Statistics error message returned on failure. |
| errmsg | string | Requested message for error log |
| code | integer | Error code if success == false |
Example
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:
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:
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json?errid=1"