Ops Center Analyzer REST API Reference Guide

Version: 10.8.x
File Size: 4.6 MB
Audience: anonymous
Part Number: MK-99ANA003-10

Overview
API architecture
Common specifications of the API functions
Communication protocols and port numbers
Execution permission
Security and authentication
Request and response formats
Request format of the API
URI format
Supported HTTP methods
Request Line format description
Information in the request header
Response format of the API
Status description
Response headers descriptions
Response body description
HTTP status codes description
Error information for errors in API requests
Query parameters in the API
Query parameter for all APIs
Query parameters for some APIs
HQL syntax relationships and operators
Domain object format
Resources managed through the API
API request list
List of enumerators
Performing operations related to the rules for automatically assigning resources
Getting a list of automatic resource assignment rules
Creating automatic resource assignment rule
Getting specific automatic resource assignment rule information
Updating specific automatic resource assignment rule
Deleting specific automatic resource assignment rule
Getting a list of operations for information about automatic resource assignment rules
Preparing to obtain a list of condition information for automatic resource assignment rules
Getting a list of condition information for automatic resource assignment rules
Preparing to update a condition information for automatic resource assignment rules
Updating condition information for automatic resource assignment rules
Getting a list of operations for automatic resource assignment rules
Preparing to change the priority of automatic resource assignment rules
Changing the priority of automatic resource assignment rules
Preparing to assign resources
Assigning resources
Preparing to obtain the results of automatic host distribution
Getting the results of automatic host distribution
Preparing to obtain the results of automatic virtual machine distribution
Getting the results of automatic virtual machine distribution
Preparing to obtain the results of automatic volume distribution
Getting the results of automatic volume distribution
Performing operations related to the history of changes made to the configuration
Getting a list of configuration change histories
Getting specific history of configuration changes
Getting a list of operations for specific history of configuration changes
Preparing to obtain the number of configuration changes
Getting the number of configuration changes
Preparing to obtain a trend in the number of configuration changes
Getting trend in the number of configuration changes
Performing operations related to executing actions
Getting a list of operations for execute action functions
Preparing to obtain a list of actions that can be executed by the execute action function
Getting a list of actions that can be executed by the execute action function
Preparing to obtain a detailed information about emails that can be sent by the execute action function
Getting detailed information about emails that can be sent by the execute action function
Preparing to obtain a detailed information about commands that can be sent by the execute action function
Getting detailed information about commands that can be executed by the execute action function
Preparing to execute commands that can be executed by the execute action function
Executing commands that can be executed by the execute action function
Preparing to reload a list of actions that can be executed by the execute action function
Reloading a list of actions that can be executed by the execute action function
Preparing to get a list of the actions that can be executed by using the execute action function of the target resources
Getting a list of the actions that can be executed by using the execute action function of the target resources
Preparing to get detailed information about the commands that can be executed by using the execute action function of the target resource
Getting detailed information about the commands that can be executed by using the execute action function of the target resource
Preparing to execute a command using the execute action function of the target resource
Executing a command using the execute action function of the target resource
Getting information needed to get details about an Ops Center Automator service that is executable by the execute action function
Getting details about an Ops Center Automator service that is executable by the execute action function
Getting a list of resources
Getting a list of resources
Performing operations related to resource information in E2E View
Getting a list of resources that are displayed in the E2E view
Preparing to obtain topology data for resources that are displayed in the E2E view
Getting topology data for resources that are displayed in the E2E view
Preparing to obtain details about resources that are displayed in the E2E view
Getting details about resources that are displayed in the E2E view
Preparing to obtain a query parameters used to display the E2E view
Getting query parameters used to display the E2E view
Preparing to obtain a list of resources related to the E2E view
Getting a list of resources related to the E2E views
Preparing to obtain a query parameters used to display resources in the E2E view
Getting query parameters used to display resources in the E2E view
Preparing to get resource information
Getting resource information
Setting up a mail server
Getting a list of email server settings
Uploading specific email server settings
Getting a list of operations for email server settings
Preparing to send a test mail
Sending a test mail
Performing operations related to event information
Getting a list of events
Getting specific event information
Getting a list of operations for events
Preparing to obtain number of events
Getting a number of events
Getting information about a consumer grade
Getting a list of grades
Performing operations related to consumers
Getting a list of consumers
Creating consumer
Getting specific consumer information
Updating consumer
Deleting a specific consumer
Getting a list of operations for specific consumers
Preparing to assign a consumer
Assigning a specific consumer
Performing operations related to consumer auto creation
Getting information to generate a consumer definition
Generate a consumer definition
Getting information to preview a consumer definition
Preview a consumer definition
Getting information to submit a consumer auto creation task
Submit a consumer auto creation task
Getting information to export a consumer definition file
Export a consumer definition file
Getting information to register a consumer definition file
Register a consumer definition file
Connecting to the Analyzer detail view server
Getting a list of Analyzer detail view server connection settings
Updating specific Analyzer detail view server connection settings
Getting specific Analyzer detail view server connection settings
Getting a list of operations for configuring the connection settings of the Analyzer detail view server
Preparing to get the URL of the Analyzer detail view server
Getting the URL of the Analyzer detail view server
Getting a list of operations for configuring Analyzer detail view server connection settings
Preparing to check the connection to Analyzer detail view server
Checking the connection to Analyzer detail view server
Performing operations related to Storage I/O control settings
Getting a list of tasks related to Storage I/O control settings
Getting information about a specific Storage I/O control settings task
Getting a list of actions related to Storage I/O control configuration task history
Getting the parameter used to update the status of a Storage I/O control settings task
Updating the status of a Storage I/O control settings task
Getting a list of actions related to Storage I/O control settings
Getting the parameters used to configure Storage I/O control settings
Configuring Storage I/O control settings
Performing operations related to sessions that use HSSO tokens
Getting a list of operations for sessions of the HSSO token
Preparing to extend the valid period of a session of the HSSO token
Extending the valid period of a session of the HSSO token
Performing operations related to email addresses
Getting a list of mail addresses
Creating a mail address
Getting specific mail address information
Updating specific mail address
Deleting specific mail address
Getting a list of operations for specific email address information
Preparing to assign a notification profile
Assigning a notification profile
Getting a list of operations for mail addresses
Preparing to change the status of email addresses
Changing the status of email addresses
Performing operations related to notification profiles
Getting a list of notification profiles
Creating notification profile
Getting specific notification profile information
Updating notification profile
Deleting specific notification profile
Getting a list of operations for specific notification profile configuration information
Preparing to assign notification-destination email addresses
Assigning notification-destination email addresses
Getting a list of operations for notification profiles
Preparing to obtain a list of notification target categories for notification profiles
Getting a list of notification target categories for notification profiles
Performing operations related to resource information and metric information
Getting specific metric information
Getting a list of operations for specific metrics
Preparing to obtain performance graph data for specific metrics
Getting performance graph data for specific metrics
Getting a list of operations for resources
Preparing to obtain a list of metrics related to resources
Getting a list of metrics related to resources
Getting a list of metrics for components
Getting a list of metrics
Getting a list of operations for performance information
Preparing to obtain performance information for metrics
Getting performance information for metrics
Preparing to obtain metric information
Getting metric information
Getting a list of metrics for devices
Getting a list of metrics for virtual machines
Getting a list of metrics for volumes
Performing operations related to predictive histories
Getting a list of task histories for a predictive operation
Getting predictive history information
Deleting a predictive history
Getting a list of predictive history actions
Getting the parameter used to obtain predictive results
Getting predictive results
Getting the parameter used to get metrics for the predictive result
Getting metrics for the predictive result
Getting the license status of the Predictive Analytics feature
Getting the license status of the Predictive Analytics feature
Performing operations related to analytics engines
Getting a list of analytics engines
Getting information about an analytics engine
Executing a predictive operation
Getting a list of predictive tasks
Getting information about a predictive task
Getting a list of predictive-related operations
Preparing to predict a result
Predicting a result
Preparing to cancel a predictive operation
Canceling a predictive operation
Performing operations related to predictive profiles
Getting a list of predictive profiles
Creating a new predictive profile
Getting information about a predictive profile
Updating a predictive profile
Deleting a predictive profile
Performing operations related to predictive reports
Getting a list of predictive reports
Creating a new predictive report
Getting information about a predictive report
Updating a predictive report
Deleting a predictive report
Getting a list of the recovery action history
Getting a list of recovery action history
Performing operations related to recovery action
Creating a new recovery action history
Getting information about recovery action history
Updating recovery action history
Deleting recovery action history
Getting information about storage systems
Getting a list of storage system models
Getting a list of storage system pools
Performing operations related to suggestions
Getting a list of operations related to suggestions
Preparing to obtain the suggestions
Getting suggestions for resolving performance problems
Getting information about the system
Getting system information
Performing operations related to system summary information
Getting a list of system summary informations
Preparing to obtain a system summary information
Getting system summary information
Getting the information needed to calculate dynamic thresholds
Getting margin information used for dynamic threshold calculations
Performing operations related to threshold properties files
Getting a list of threshold profiles
Creating threshold profile
Getting specific threshold profile information
Updating specific threshold profile
Deleting specific threshold profile
Getting a list of operations for specific threshold profiles
Preparing to assign specific threshold profile
Assigning specific threshold profile
Preparing to obtain a threshold information with profiles and resources specified
Getting a list of threshold informations with profiles and resources specified
Preparing to set dynamic thresholds with profiles and resources specified
Setting dynamic thresholds with profiles and resources specified
Performing operations related to user resources
Getting a list of operations for user resources
Preparing to obtain the number of user resources counted for each metric and for each status
Getting the number of user resources counted for each metric and for each status
Performing operations related to user information
Getting a list of users
Creating a user
Getting specific user information
Updating specific user information
Deleting specific user
Performing operations related to virtual machines
Getting a list of virtual machines
Performing operations related to volumes
Getting a list of volumes
Accessing RAID Agent
Notes on using API functions that access RAID Agent
Maximum number of concurrent API requests that can access RAID Agent
Common specifications of the API functions that access RAID Agent
Transmission in compressed format
Common objects
Collection object
Error object
Action object
PrimitiveValue object
API resources and requests for accessing RAID Agent
Obtaining the RAID Agent list parameter when the manual refresh process is executed
Manually refreshing the RAID Agent list
Obtaining a list of RAID Agent instances
Obtaining a list of RAID Agent instances
Obtaining performance data
Obtaining a list of RAID Agent administrative actions
Obtaining the detailed version information of the API
Obtaining metadata
Supplemental information on performance data collected by RAID Agent using APIs
Format of record explanations
List of common key fields
List of data types
Delta
Notes on collecting records
Types of performance information that can be acquired depending on the Access Type
Notes on values acquired from VSP N series
Restrictions regarding volumes, ports and parity group for mainframe systems
Whether performance information is collectible when using a storage system management program
Collectability of performance data when using VMware VVol
Whether performance data is collectible when using global-active device
Whether performance information is collectible when using Compatible PAV or Compatible Hyper PAV
Record creation results when data cannot be obtained
Capacity monitoring of pools
Retention periods for records
RAID Agent records (collection via the command device)
PD
PD_CLPC
PD_ELC
PD_LDC
PD_LSEC
PD_PEFF
PD_PLC
PD_PLF
PD_PLR
PD_PLTC
PD_PLTR
PD_PLTS
PD_PTC
PD_RGC
PD_SEFF
PD_UMS
PD_VVC
PD_VVF
PD_VVTC
PI
PI_CHS
PI_CLMS
PI_CLPS
PI_JNLS
PI_LDA
PI_LDE
PI_LDS
PI_PLS
PI_PLTI
PI_PRCS
PI_PTS
PI_RGS
PI_VVTI
RAID Agent records (collection via the SVP by using a TCP/IP connection)
PD_PDX
PD_UMSX
PI_CBMB
PI_CCMS
PI_CHAC
PI_CHDR
PI_CLMX
PI_CPS
PI_DBMB
PI_DKAC
PI_DKDR
PI_ELDS
PI_EVGS
PI_HBAS
PI_HWSP
PI_JNLX
PI_LDSX
PI_LDTC
PI_LDU
PI_LDUR
PI_LSP
PI_LTSP
PI_LUSP
PI_MBDR
PI_MPCS
PI_MPS
PI_MPTS
PI_PTSX
PI_RGSX
PI_RGU
PI_SCPS
PI_SCS

Back to home page