Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 9 AM CDT, Sunday, September 22, for a platform upgrade.

    Page tree
    Skip to end of metadata
    Go to start of metadata

    The perfdata API uses the POST method to obtain performance data about monitor instances.

    TSWS APIs that use the POST method
    APIDescription
    loginObtains the authToken required to perform all other operations
    configdataRetrieves configuration data of monitor instances
    perfdataRetrieves performance data of monitor instances

    TSWS APIs that use the GET method
    APIDescription
    devicesRetrieves a list of monitored devices
    instances Retrieves a list of monitored instances 
    monitortypesRetrieves a list of monitor types 
    tenantsRetrieves a list of tenants 

    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

    ElementDescription
    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.

    endTime

    End time in Epoch format.

    The start and end times should be in the range of 1 to 24 hours.

    typeonly rate is supported
    computationCurrently, only avg is supported
    attribUniqNameListEnter 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.

    monUniqNameUse the monitortypes API to get the monUniqName. You can specify only one monitor type.
    instKeyList

    Includes serverIdmonTypeId, 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:

    1. Enter the URL for the performance data of monitor instances API. The generic format is:
      https://<PresentationServerHostName>/tsws/10.0/api/omprovider/perfdata
    2. Add a new header row and select Authorization as the header type.
    3. Enter the text authToken followed by the authToken generated through the login API. See TSWS authentication.
    4. Enter the request parameters in JSON format. Ensure that none of the request parameters are empty.
      1. tenantId — the tenant name, for example "BmcRealm".
      2. Select one of the following options:
        • monUniqName
        • instKeyList that includes serverId, monTypeId, and monInstId.

        Note

        If you provide both monUniqName and instKeyList details, only the monUniqName input is considered.

      3. startTime
      4. endTime

        Note

        The start and end times should be in the range of 1 to 24 hours.

      5. type
        Currently, only rate is supported.
      6. computation
        Currently, only avg is supported.
      7. attribUniqNameList
        Enter one or more attributes of the same monitor type.
    5. 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.

    Related topics

    Generating report data with the BMC Synthetic Transaction SLA Report utility

    Developing