×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
BMC TrueSight Infrastructure Management 11.3 ... Developing Performing Infrastructure Management functions by using the REST APIs Learning about the Infrastructure Management REST API

Examples of using the REST API to retrieve data from Infrastructure Management

This section lists a few use case scenarios for Infrastructure Management. It can help you to use the Infrastructure Management web service APIs effectively. Each scenario is explained using a sample URL and its subsequent response details.

Retrieving monitor instance configuration data from a single device

URL

http://bppmwsserver/bppmws/api/Device/192.168.123.46/configdata?idType=IPAddress

Response

URI of monitor instances and attributes based on the IP address of the resource

Retrieving monitor type metadata from multiple devices

URL

http://bppmwsserver:80/bppmws/api/Device/192.168.123.46,192.168.123.2/metadata?idType=IPAddress

Response

Metadata information about monitor types and attributes for each device, based on the IP addresses of the resources

Retrieving performance statistics data from multiple devices having multiple monitor types

URL

http://bppmwsserver:80/bppmws/api/Device/192.168.123.1,192.168.123.2,192.168.123.3/stats?starttime=2010-06-23T17:00:00&endtime=2010-07-07T17:00:00&idType=IPAddress&monitor=CPU:CPU_UTILIZATION,CPU_EXTRA;Processor:CPU_TOTAL_UTIL

Response

Performance statistics data from multiple devices for the specified monitor types, based on the IP addresses of the resources for the specified time period

Retrieving performance statistics data for the monitor instances using their URIs

URL

http://bppmwsserver:80/bppmws/api/MonitorInstance/NGPServ3:1234:345,NGPServ3:1234:346/stats?starttime=2010-06-23T17:00:00&endtime=2010-07-07T17:00:00&idType=URI

Response

Performance statistics data for the specified monitor instances for the specified time period (grouped by monitor instances) for the attributes that are of type KPI

Retrieving performance statistics data for the monitor instances using their URIs and the specified monitor types and attributes

URL

http://bppmwsserver:80/bppmws/api/MonitorInstance/NGPServ3:1234:345,NGPServ3:1234:346/stats?starttime=2010-06-23T17:00:00&endtime=2010-07-07T17:00:00&idType=URI&monitor=CPU:CPU_UTILIZATION,CPU_EXTRA;MEMORY:MEMORY_Utilized,MEMORY_Baloon

Response

Performance statistics data grouped by monitor instances for the specified attributes for the specified time period

Retrieving performance statistics data from multiple devices with multiple monitor types based on the IP addresses of the resources

URL

http://bppmwsserver:80/api/Device/192.168.123.1,192.168.123.2,192.168.123.3,192.168.123.4,192.168.123.5/stats?idType=IPAddress&monitor=CPU:CPU_UTILIZATION,CPU_EXTRA;Processor:CPU_TOTAL_UTIL

Response

Performance statistics data from the specified devices for the specified attributes

Was this page helpful? Yes No Submitting... Thank you
Last modified by Harihara Subramanian on Oct 21, 2020
web_services development infra_management reference

Comments

Log in or register to comment.

Utilities for the Infrastructure Management REST API
Examples of using the REST API to retrieve data and search CIs
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.