The perfdata
API uses the POST method to obtain performance data about monitor instances.
API | Description |
---|---|
login | Obtains the authToken required to perform all other operations |
configdata | Retrieves configuration data of monitor instances |
perfdata | Retrieves performance data of monitor instances |
API | Description |
---|---|
devices | Retrieves a list of monitored devices |
instances | Retrieves a list of monitored instances |
monitortypes | Retrieves a list of monitor types |
tenants | Retrieves a list of tenants |
You must have used the login
API to obtain the authToken, which authenticates the user performing the operation. For details, see TSWS authentication.
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/perfdata
Element | Description |
---|---|
tenantId | Tenant name Example: BmcRealm |
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 |
After you access the REST client, perform the following steps:
Note
If you provide both monUniqName and instKeyList details, only the monUniqName input is considered.
endTime
Note
The start and end times should be in the range of 1 to 24 hours.
rate
is supported.avg
is supported.The following sample JSON response contains the performance data for the perfdata API:
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:
Check for these conditions and modify the input accordingly.