Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command, Definition File and API Reference


5.1 List of APIs

The following table lists APIs that can be used with the user-created plug-in of JP1/IM.

Table 5‒1: List of APIs of the user-created plug-in

Category

API name

Description

User authentication

Login

Logs in to the Intelligent Integrated Management Base.

Logout

Logs out from the Intelligent Integrated Management Base.

Link information

Link information acquisition

Gets the link information that represents order relationships between objects.

Link type list acquisition

Gets the list of types of link information.

Event management

Event search

Searches the integrated monitoring database for events based on specified conditions.

Event detailed information acquisition

Gets the details of a specified event.

Event status change

Changes the event status of specified events.

Event generation

Generates the specified event.

Performance information

Plug-in processing execution

Executes plug-in operations for performance information.

System status monitoring

IM management node information acquisition

Gets the information of IM management nodes collected from JP1/AJS3, JP1/PFM, JP1/IM, JP1/Base, and others.

Configuration management tree information acquisition

Gets the configuration information of IM management nodes (management groups or management objects) as a tree.

IM management node status acquisition

Gets the status information of all IM management nodes (management groups or management objects).

Suggestion mapping information acquisition

Gets information regarding the mapping between IM management nodes and suggestion IDs.

Proxy

Proxy credential setup

Sets the authentication user and password of the proxy server.

Linked product

URL information acquisition

Gets the URL to start a linked product configured in an IM management node.

Trend

Metric list acquisition

Gets the list of metrics for the specified SID.

Time-series data

Gets time-series data for the specified SID.

Information management

Version information acquisition

Gets the JP1/IM version and REST API versions.

Suggestion

Previous execution history acquisition

Gets a history of previously executed response actions.

Response action suggestion

Suggests response actions appropriate to the system status.

Response action execution

Executes a response action.

OpenID authentication

Single sign-on mapping definition application

Applies the mapping information defined in the single sign-on mapping definition file (imdd_sso_mapping.properties) to the Intelligent Integrated Management Base.