Contents

• Notices

• Summary of amendments

• Preface

• 1. Overview

  • 1.1 API architecture

  • 1.2 Common specifications of the API functions

    • 1.2.1 Communication protocols and port numbers

    • 1.2.2 Security and authentication

    • 1.2.3 Request and response formats

    • 1.2.4 Request format of the API

    • 1.2.5 Response format of the API

    • 1.2.6 HTTP status codes description

    • 1.2.7 Error information for errors in API requests

    • 1.2.8 Query parameters in the API

    • 1.2.9 HQL syntax relationships and operators

    • 1.2.10 Domain object format

  • 1.3 Resource members

    • 1.3.1 Members of the authentication information

    • 1.3.2 Members of a plug-in

    • 1.3.3 Members of the search range

    • 1.3.4 Members of the Discovered Resources

    • 1.3.5 Members of the execution result of the Discovery

    • 1.3.6 Members of the IP-address ranges included in the discovery results

    • 1.3.7 Members of collectors

    • 1.3.8 Members of authentication information used by collectors

    • 1.3.9 Members of the collection-interval settings

    • 1.3.10 Members of the user settings information

    • 1.3.11 Members of GUI-display settings set by users

    • 1.3.12 Members of a user profile

    • 1.3.13 Members of a user profile threshold

    • 1.3.14 Members of a system profile

    • 1.3.15 Members of a system profile threshold

    • 1.3.16 Members of a consumer

    • 1.3.17 Members of a grade

    • 1.3.18 Members of the application

    • 1.3.19 Members of application resource information

    • 1.3.20 Members of application container information

    • 1.3.21 Members of a container cluster

    • 1.3.22 Members of a container node

    • 1.3.23 Members of a pod

    • 1.3.24 Members of a cluster

    • 1.3.25 Members of a hypervisor

    • 1.3.26 Members of a virtual machine

    • 1.3.27 Members of a host

    • 1.3.28 Members of a datastore

    • 1.3.29 Members of an IP Switch

    • 1.3.30 Members of an FC Switch

    • 1.3.31 Members of a storage system

    • 1.3.32 Members of a volume

    • 1.3.33 Members of a Service Resource

    • 1.3.34 Members of a Service Instance

    • 1.3.35 Members of an acquired list of resources

  • 1.4 Resources managed through the API

  • 1.5 API request list

  • 1.6 List of enumerators

  • 1.7 API description format

  • 1.8 Operating JP1/OA by using the API functions

    • 1.8.1 Creating authentication information

    • 1.8.2 Creating a search range

    • 1.8.3 Creating a collector

    • 1.8.4 Creating a user profile

    • 1.8.5 Creating a system profile

    • 1.8.6 Creating a consumer

    • 1.8.7 Assigning a user profile

    • 1.8.8 Assigning a system profile

    • 1.8.9 Acquiring event information in CSV format

    • 1.8.10 Acquiring basic information and performance information for resources in CSV format

• 2. List of API functions

  • 2.1 List of API requests related to authentication information

    • 2.1.1 Obtaining Authentication

    • 2.1.2 Obtaining Authentication Information

    • 2.1.3 Creating Authentication

    • 2.1.4 Updating Authentication

    • 2.1.5 Deleting Authentication

  • 2.2 List of API requests related to plug-ins

    • 2.2.1 Obtaining a List of Plug-in Information

    • 2.2.2 Obtaining Plug-in Information

  • 2.3 List of API requests related to retrieval ranges (IP address ranges)

    • 2.3.1 Obtaining Retrieval Ranges

    • 2.3.2 Obtaining Retrieval Range Information

    • 2.3.3 Creating Retrieval Ranges

    • 2.3.4 Updating Retrieval Ranges

    • 2.3.5 Deleting Retrieval Ranges

  • 2.4 List of API requests related to discovery

    • 2.4.1 Obtaining Discovery Operation List

    • 2.4.2 Obtaining the Information Necessary To Run a Discovery

    • 2.4.3 Running a Discovery

    • 2.4.4 Obtaining the Information Necessary To Stop a Discovery

    • 2.4.5 Stopping a Discovery

    • 2.4.6 Obtaining Information about Discovered Resources

    • 2.4.7 Obtaining Discovery History

  • 2.5 List of API requests related to collectors

    • 2.5.1 Obtaining Collector List

    • 2.5.2 Obtaining Collector Information

    • 2.5.3 Creating Collector

    • 2.5.4 Updating Collector

    • 2.5.5 Deleting Collector

  • 2.6 List of API requests related to collection-interval settings

    • 2.6.1 Updating monitoring interval

    • 2.6.2 Getting monitoring interval information

  • 2.7 List of API requests related to information about user settings

    • 2.7.1 Acquiring a List of Custom Settings of a User

    • 2.7.2 Specifying Settings for a User

    • 2.7.3 Acquiring a List of Operations for the Custom Settings of a User

    • 2.7.4 Collecting Information Necessary for Deleting the Custom Settings of a User

    • 2.7.5 Deleting the Custom Settings of a User

  • 2.8 List of API requests related to user profiles

    • 2.8.1 Obtaining User Profile List

    • 2.8.2 Obtaining User Profile Information

    • 2.8.3 Creating User Profile

    • 2.8.4 Updating User Profile

    • 2.8.5 Delete User Profiles

    • 2.8.6 Obtaining User Profile Operation

    • 2.8.7 Obtaining User Profile Allocation Information

    • 2.8.8 Allocating User Profile

  • 2.9 List of API requests related to system profiles

    • 2.9.1 Obtaining System Profile List

    • 2.9.2 Obtaining System Profile Information

    • 2.9.3 Creating System Profile

    • 2.9.4 Updating System Profile

    • 2.9.5 Delete System Profiles

    • 2.9.6 Obtaining System Profile Operation List

    • 2.9.7 Obtaining System Profile Allocation Information

    • 2.9.8 Allocating System Profile

  • 2.10 List of API requests related to consumers

    • 2.10.1 Obtaining Consumer List

    • 2.10.2 Getting specific consumer information

    • 2.10.3 Obtaining Grade List

    • 2.10.4 Creating consumer

    • 2.10.5 Updating consumer

    • 2.10.6 Deleting specific consumer

    • 2.10.7 Obtaining Consumer Operation List

    • 2.10.8 Obtaining Consumer Allocation Information

    • 2.10.9 Allocating Consumer

    • 2.10.10 Obtaining Consumer Allocation Information with a Specified Resource Allocation Category

    • 2.10.11 Allocating Consumers that Have a Resource Allocation Category Specified

  • 2.11 List of API requests related to application

    • 2.11.1 Obtaining Application List

  • 2.12 List of API requests related to container clusters

    • 2.12.1 Obtaining Container Cluster List

  • 2.13 List of API requests related to container nodes

    • 2.13.1 Obtaining Container Node List

    • 2.13.2 Obtaining Container Node Operation List

    • 2.13.3 Obtaining Container Node Monitoring Status Change Information

    • 2.13.4 Changing Container Node Monitoring Status

  • 2.14 List of API requests related to pods

    • 2.14.1 Obtaining Pod List

    • 2.14.2 Obtaining Pod Operation List

    • 2.14.3 Obtaining Pod Monitoring Status Change Information

    • 2.14.4 Changing Pod Monitoring Status

  • 2.15 List of API requests related to clusters

    • 2.15.1 Obtaining Cluster List

  • 2.16 List of API requests related to hypervisors

    • 2.16.1 Obtaining Hypervisor List

    • 2.16.2 Obtaining Hypervisor Operation List

    • 2.16.3 Obtaining Hypervisor Monitoring Status Change Information

    • 2.16.4 Changing Hypervisor Monitoring Status

  • 2.17 List of API requests related to virtual machines

    • 2.17.1 Obtaining Virtual Machine List

    • 2.17.2 Obtaining Virtual Machine Operation List

    • 2.17.3 Obtaining Virtual Machine Monitoring Status Change Information

    • 2.17.4 Changing Virtual Machine Monitoring Status

  • 2.18 List of API requests related to hosts

    • 2.18.1 Obtaining Host List

    • 2.18.2 Obtaining Host Operation List

    • 2.18.3 Obtaining Host Monitoring Status Change Information

    • 2.18.4 Changing Host Monitoring Status

  • 2.19 List of API requests related to datastores

    • 2.19.1 Obtaining Datastore List

    • 2.19.2 Obtaining Datastore Operation List

    • 2.19.3 Obtaining Datastore Monitoring Status Change Information

    • 2.19.4 Changing Datastore Monitoring Status

  • 2.20 List of API requests related to IP switches

    • 2.20.1 Obtaining IP Switch List

    • 2.20.2 Obtaining IP Switch Operation List

    • 2.20.3 Obtaining IP Switch Monitoring Status Change Information

    • 2.20.4 Changing IP Switch Monitoring Status

  • 2.21 List of API requests related to FC switches

    • 2.21.1 Obtaining FC Switch List

    • 2.21.2 Obtaining FC Switch Operation List

    • 2.21.3 Obtaining FC Switch Monitoring Status Change Information

    • 2.21.4 Changing FC Switch Monitoring Status

  • 2.22 List of API requests related to storage systems

    • 2.22.1 Obtaining Storage System List

    • 2.22.2 Obtaining Storage System Operation List

    • 2.22.3 Obtaining Storage System Monitoring Status Change Information

    • 2.22.4 Changing Storage System Monitoring Status

  • 2.23 List of API requests related to Volumes

    • 2.23.1 Obtaining Volume List

  • 2.24 List of API requests related to service resources

    • 2.24.1 Obtaining Service Resource List

    • 2.24.2 Obtaining Service Resource Operation List

    • 2.24.3 Obtaining Service Resource Monitoring Status Change Information

    • 2.24.4 Changing Service Resource Monitoring Status

  • 2.25 List of API requests related to service instances

    • 2.25.1 Obtaining Service Instance List

    • 2.25.2 Obtaining Service Instance Operation List

    • 2.25.3 Obtaining Service Instance Monitoring Status Change Information

    • 2.25.4 Changing Service Instance Monitoring Status

  • 2.26 List of API requests related to the event information

    • 2.26.1 Collecting the information required to collect, into a CSV file, a list of events

    • 2.26.2 Collecting, into a CSV file, a list of events

  • 2.27 List of API requests related to the [E2E View] window

    • 2.27.1 Collecting the information required to collect, into a CSV file, information about specified resources or a list of related resources

    • 2.27.2 Collecting, into a CSV file, information about specified resources or a list of related resources

  • 2.28 List of API requests related to performance information

    • 2.28.1 Collecting the information required to collect, into a CSV file, the performance values in a time series of specified performance information

    • 2.28.2 Collecting, into a CSV file, the performance values in a time series of specified performance information

    • 2.28.3 Collecting the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds

    • 2.28.4 Collecting, into a CSV file, the latest value in the performance information that a specified resource holds

  • 2.29 List of API requests related to information management

    • 2.29.1 Obtaining Version Information

• Appendix

  • A. Version Changes

    • A.1 Changes in version 12-60

    • A.2 Changes in version 12-50

    • A.3 Changes in version 12-10

    • A.4 Changes in version 12-00

    • A.5 Changes in version 11-50

• Index

To Page Top