Agent Data API

Agent Data REST API is used to analyze real-time and short-term historical data to address any capacity and performance issues in your environment.


Prerequisite: The TrueSight Capacity Optimization Gateway Server with  TrueSight Capacity OptimizationAgents must be either in active Manager runs or in the Uncatalogued Systems list.

The following table provides the details of the Agent Data API methods:

Method

URI Pattern

Description

Sample Request

Sample Response

POST

agent-data/v1/servers/

Retrieves a list of servers, including the metadata for the servers. You can retrieve a specified set of servers when:

  • A server parameter is declared, a case insensitive search is performed in 'like' mode.
  • Operators are added by the call and 'like' operators are not required from the client. A search is performed as '%searchString%'.
Sample request

{

    "server.list": [

        "bpa",

        "dv0"

    ],

    "pagination": {

        "page": 1,

        "size": 3

    }

}

Sample response

  "servers": [

    {

      "server.name": "bl-aus-bco-dv01.bmc.com",

      "collection.server": "http://vl-pun-bco-qa66.bmc.com:10129"

    },

    {

      "server.name": "bw-aus-bco-dv01.bmc.com",

      "agent.os": "Windows",

      "collection.server": "http://vl-pun-bco-qa66.bmc.com:10129"

    },

    {

      "server.name": "bw-pun-bco-dv01",

      "collection.server": "http://vl-pun-bco-qa66.bmc.com:10129"

    }

  ],

  "pagination": {

    "page": 1,

    "size": 3,

    "has.more.data": true

  }

}

POST

agent-data/v1/servers/bydomain/{domainid}/

Lists available nodes for a specific domain ID. If the domain ID is 0 or null, it returns the nodes that are associated to All domains and the dissociated nodes. 

Parameter required: domainid

Sample response

{
    "domains": [
        {
            "domain": "All domains",
            "structureid": "APP",
            "typeid": "0",
            "id": "0",
            "servers": [
                {
                    "server.name": "vm.aaa.com",
                    "os": "win",
                    "type": "CAPACITY_AGENT",
                    "collection.server": "gm.coll.com",
                    "structureid": "SYS",
                    "id": "xxx",
                    "typeid": "25"
                },
                {
                    "server.name": "vm2.aaa.com",
                    "os": "linux",
                    "type": "CAPACITY_AGENT",
                    "collection.server": "gm2.coll.com",
                    "structureid": "SYS",
                    "id": "xxx",
                    "typeid": "25"
                }
            ]
        },
        {
            "domain": "Unassociatednodes",
            "structureid": "APP",
            "typeid": "0",
            "id": "-999",
            "servers": [
                {
                    "server.name": "vm2.aaa.com",
                    "os": "win",
                    "type": "CAPACITY_AGENT",
                    "collection.server": "gm.coll.com",
                    "structureid": "SYS",
                    "typeid": "25"
                }
            ]
        }
    ]
}

POST

agent-data/v1/collection-groups/

Lists the metric groups retrieved from the metadata that is stored in the TrueSight Capacity Optimization database.


Sample request

{
    "os.list": [
        "Windows",
        "Solaris",
        "linux"
    ]
}


Sample response

{
  "os.list": [
  {
    "os": "Windows",
    "collected.metrics": [
     {
       "collection.groups": [
         "collection.group.metadata":
          {
         "collection.group.path": "Windows/CPU"
          }
        ]
     },
    ]
    {
      "os": "linux",
      "collected.metrics": [
       {
         "collection.groups": [
            "collection.group.metadata":
            {
             "collection.group.path": "Unix/CPU"
            }
          ]
        }
       ]
}

POST

agent-data/v1/collectiongroups/metrics/

Retrieves the associated set of 'collected metrics' for a specific collection group.

Sample request

{
  "os.list": [
    {
      "os": "Solaris",
      "collected.metrics": [
        {
          "collection.group": "Cpu Statistics",
          "collection.group.metadata": {
            "collection.group.path": "Unix/CPU"
          }
        }
      ]
    }
  ]
}

Sample response

{
 "href": http://clm-xxx-022436:8280/dh-services/agent-data/v1/collection-groups/metrics,
 "agent.type": "CAPACITY_AGENTS", "os.list": [
    {
      "os": "Solaris",
      "collected.metrics": [
        {
          "collection.group": "Cpu Statistics",
          "collection.group.metadata": {
            "collection.group.subresources": [
              "CPU ID"
            ],
            "collection.group.path": "Unix/CPU"
          },
          "metric.data.types": [
            {
              "metric": "CPU ID",
              "data.type": "STRING",
              "hidden": 0
            },
            {
              "metric": "CPU Idle Time",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU Interrupt Time",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU Involuntary Wait",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU System Time",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU User Time",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU Utilization",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "CPU Wait Time",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "Pset ID",
              "data.type": "STRING",
              "hidden": 1
            },
            {
              "metric": "Spins On Mutexes",
              "data.type": "NUMBER",
              "hidden": 1
            },
            {
              "metric": "System Busy",
              "data.type": "NUMBER",
              "hidden": 0
            },
            {
              "metric": "Time",
              "data.type": "STRING",
              "hidden": 0
            }
          ]
        }
      ]
    }
  ]
}

POST

agent-data/v1/timeranges/

Retrieves available time ranges for a specific set of servers or collection groups.

Sample request

{
 "servers": [
  {
    "server.name": "localhost",
    "collected.metrics":  [
      {
        "collection.group": "System Statistics"
      }
     ]
  },
  {
    "server.name": "portaldev1",
    "collected.metrics": [
      {
        "collection.group": "System Statistics"
      }
     ]
   }
  ]
}

Sample response

{
  "time.ranges.list": [
    {
      "server.name": "localhost",
      "collection.server": "http://gm.coll.com:10129"
      "collection.group": "System Statistics",
      "time.ranges": {
        "2015-09-08 05:43:39": "2015-09-08 20:40:55",
        "2015-09-08 20:29:35": "2015-09-09 20:29:55",
        "2015-09-09 20:29:35": "2015-09-10 20:29:55"
      }
    }
  {
      "server.name": "portaldev1",
      "collection.server": "http://gm.coll.com:10129"
      "collection.group": "System Statistics",
      "time.ranges": {
        "2015-09-08 05:43:39": "2015-09-08 20:40:55",
        "2015-09-08 20:29:35": "2015-09-09 20:29:55",
        "2015-09-09 20:29:35": "2015-09-10 20:29:55"
      }
    }
  ]
}

POST

agent-data/v1/data/

Retrieves the data points for a specific set of the following entities:

  • servers
  • collection groups
  • metrics
  • time period
  • resolution
Sample request

{
"analysis.type" : "CHART_ANALYSIS",

   "servers":[ 
      { 
         "server.name":"pl-xxx-bco-dv01",
         "collected.metrics":[ 
            { 
              "collection.group":"System Statistics",
               "collection.group.metadata":{ 
                  "collection.group.path":"Unix/CPU",
                  "collection.group.subresources":[ 
                     "CPU ID"
                  ]
               },
               "metrics":[ 
                  "CPU Utilization"
               ]
            }
         ]
      }
   ],
    "time.filter": {
        "lastex": "H1"
      }
}

Sample response

Failed to resolve macro content placeholder Cause: [null]. Click on this message for details.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*