Versions Compared

Key

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

...

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-01-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-01-20. The date is inclusive, meaning that all data from a particular day will be included in the report.

...

FieldTypeDescription
success

boolean

Indicates whether 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, 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.

...

FieldTypeDescription
success

boolean

Indicates whether the 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.

...

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 use the command similar to this one:

Code Block
languagejs
firstline1
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json?errid=1"