...
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 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 is in YYYY-MM-DD format; for example, 2017-05-20. |
| ed | Yes | string | Specifies end date from 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. |
Response
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}
} |
...
| Field | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
success | boolean | Indicates whether 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:
| ||||||||||||||
errid | integer | ID of the entry in the License Statistics error log. | ||||||||||||||
| code | integer | Error code for unsuccessful request. | ||||||||||||||
| totalCount | integer | Total number of all matching results. |
Example
Say you would like to obtain The following example shows a command that obtains information about the 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 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" |
...
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 followsare described below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${errorId} | Yes | integer | Specifies ID of the error log for which the error message should be retrieved. |
Response
The following code block shows an example result of a successful request.
...
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates 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. |
| code | integer | Error code for unsuccessful request. |
Example
Say you would like to The following example shows a command that lets you 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 You can also put parameters directly in the URL; for the above example, to view the message for error "1", use a command similar to the one you can see belowcommand would look like the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/uptime/error/json?errid=1" |
...