Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With License Statistics API, you can easily generate information about license server uptime, i.e. statistics about The License Server Uptime endpoint delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch license usage metrics specific to  license server status for any the currently selected license server during any period the server status was monitored. 

Obtaining information about license server status

If you want to retrieve information fetch metrics about license server status history, we recommend that you use the following URL request template.

Code Block
languagejs
firstline1
linenumberstrue
GET /api/v1/report/uptime/server/${licenseServerId}/json?sd=${startDate}&ed=${endDate}

where :- $ $ indicates a variable value that you can replace with a proper value, according to value that best suits your needs
- and the possible parameters are as follows:

ParameterRequiredTypeDescription
${licenseServerId}Yesinteger

Specifies ID of the license server for which you want to view the status information.  

sdYesstring

Specifies starting date from which you want to generate the report. The date format is YYYY-MM-DD; for example, 2017-0105-20.

ed

Yes

string

 Specifies end date from which you want to generate the report. The date format is YYYY-MM-DD; for example, 2017-0105-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: The following code block shows an example result of a successful request:

Code Block
languagejs
firstline1
linenumberstrue
  {
      success: ${success},
      msg: ${message},
      data: [{  
         "lsucd":${licenseServerUptimeCheckDateTime},
         "lssid":${licenseServerStatusId},
         "errid":${errorLogId}
      }],
	  "code": ${errorCode},
	  "totalCount": ${totalCount}
  }

where the response fields can be explained as follows:

FieldTypeDescription

success

boolean

Indicates whether the that your 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, which can be one of the following:

IDStatus
1UNKNOWN
2UP
3DOWN
4INTERNAL ERROR
5VERIFYING
6DISABLED

errid

integer

ID of the entry in the License Statistics error log.

codeintegerError code for unsuccessful request.
totalCountinteger

Total number of all matching results.

...

Say you would like to view information about uptime of license server 1 in January of 20152017. To generate such data, enter a command similar to the following:

Code Block
languagejs
firstline1
linenumberstrue
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 Please keep in mind that you can also put parameters directly into the URL, e.g. to generate data for the above example, the command would look like this:

Code Block
languagejs
firstline1
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/server/1/json?sd=20152017-01-01&ed=20152017-01-31"

Obtaining information about error messages

If you want to retrieve information fetch metrics about error message of any given log, we recommend that you use the following URL request template. 

Code Block
languagejs
firstline1
linenumberstrue
GET /api/v1/report/uptime/error/json?errid=${errorId}

where :- $ $ indicates a variable value that you can replace with a proper value, according to value that best suits your needs
- and the possible parameters are as follows:
 

ParameterRequiredTypeDescription
${errorId}Yesinteger

Specifies ID of the error log , for which the error message should be retrieved.


If your request is successful, you should see a response similar to the following:  The following code block shows an example result of a successful request:

Code Block
languagejs
firstline1
linenumberstrue
 {
      success: ${success},
      msg: ${message},
      data: {
        "errmsg": ${errorMessage}
      },
      code: ${code}
 }

...

FieldTypeDescription
success

boolean

Indicates whether the that your API request was successfully processed.

msg

string

License Statistics error message returned on failure.

errmsg

string

The message you want to retrieve for a specific error log.

codeinteger

Error code for unsuccessful request.


Example

For example, say 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:

...