Retrieving the performance data of monitor instances
Before you begin
You must have used the login API to obtain the authToken, which authenticates the user performing the operation. For details, see TSWS-authentication.
Request syntax
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/perfdata
Request parameters
Element | Description |
|---|---|
tenantId | Tenant name Example: * |
startTime | Start time in Epoch format. The start and end times should be in the range of 1 to 24 hours. Note: If you want to retrieve current performance data for a time range(Say for example: 24-hours/1-day duration), we recommend to query for the performance data two hours after the time-range since by this time sufficient data points would have been retrieved for a successful response. If you want to retrieve historical performance data for a time range(Say for example: 72-hours/3-days duration), we recommend to query for the performance data two hours after the time-range since by this time sufficient data points would have been retrieved for a successful response. |
endTime | End time in Epoch format. The start and end times should be in the range of 1 to 24 hours. Note: If you want to retrieve current performance data for a time range(Say for example: 24-hours/1-day duration), we recommend to query for the performance data two hours after the time-range since by this time sufficient data points would have been retrieved for a successful response. If you want to retrieve historical performance data for a time range(Say for example: 72-hours/3-days duration), we recommend to query for the performance data two hours after the time-range since by this time sufficient data points would have been retrieved for a successful response. |
type | only rate is supported |
computation | Currently, only avg is supported |
attribUniqNameList | Enter one or more attributes of the same monitor type. |
One of the following elements If you specify both monUniqName and instKeyList details, only the monUniqName input is used. | |
monUniqName | Use the monitortypes API to get the monUniqName. You can specify only one monitor type. |
instKeyList | Includes serverId, monTypeId, and monInstId. Use the instances API to get the serverId, monTypeId, and monInstId |
Sample request with REST client
After you access the REST client, perform the following steps:
- Enter the URL for the performance data of monitor instances API. The generic format is:
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/perfdata - Add a new header row and select Authorization as the header type.
- Enter the text authToken followed by the authToken generated through the login API. See TSWS-authentication.
- Enter the request parameters in JSON format. Ensure that none of the request parameters are empty.
- tenantId — the tenant name, for example "*".
Select one of the following options:
- monUniqName
- instKeyList that includes serverId, monTypeId, and monInstId.
- startTime
endTime
- type
Currently, only rate is supported. - computation
Currently, only avg is supported. - attribUniqNameList
Enter one or more attributes of the same monitor type.
- Click Send.
Sample JSON response
The following sample JSON response contains the performance data for the perfdata API:
Troubleshooting
When multiple instance keys (instKeyList) details are provided as input, you might receive a 206 Partial Content message in the output. The possible reasons are:
- All instance keys do not belong to the same monitor unique name. Instance keys are scanned in the order they appear in the instKeyList. The first monitor unique name found from the instance key is considered as a valid monitor unique name and data is retrieved for all instance keys with this monitor unique name. Other instance keys having a different monitor unique name is considered as invalid.
- Duplicate instance keys are present in the instKeyList.
- Parameters in the instance key could not be parsed into a valid type.
Check for these conditions and modify the input accordingly.