API resources and requests for accessing RAID Agent

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

The following table lists and describes API resources and requests for accessing RAID Agent. Note that the resources are indicated by their URLs.

Use of the API		Request		Reference
Use of the API		HTTP method	URI	Reference
APIs that must be executed before obtaining performance data
This request obtains parameters when the list of RAID Agent instances is refreshed manually.		GET	/<application>/v1/services/AgentManager/actions/refresh	Obtaining the RAID Agent list parameter when the manual refresh process is executed
This request executes the process to manually refresh the list of RAID Agent instances.		POST	/<application> /v1/services/AgentManager/actions/refresh/invoke	Manually refreshing the RAID Agent list
This request obtains a list of instances.		GET	/<application>/v1/objects/Agents	Obtaining a list of instances with a query
This request obtains a list of instances.		GET	/<application>/v1/objects/AgentForRAID	Obtaining a list of instances without using a query
API functions that obtain performance data collected^{1, 2}
This request obtains the performance data of a logical device.	PD_ELC records	GET	/<application>/v1/objects/RAID_PD_ELC	Obtaining performance data
	PD_LDC records	GET	/<application>/v1/objects/RAID_PD_LDC
	PD_LSEC records	GET	/<application>/v1/objects/RAID_PD_LSEC
	PI_ELDS records	GET	/<application>/v1/objects/RAID_PI_ELDS
	PI_LDE records	GET	/<application>/v1/objects/RAID_PI_LDE
	PI_LDS records	GET	/<application>/v1/objects/RAID_PI_LDS
	PI_LDSX records	GET	/<application>/v1/objects/RAID_PI_LDSX
	PI_LDTC records	GET	/<application>/v1/objects/RAID_PI_LDTC
	PI_LDUR records	GET	/<application>/v1/objects/RAID_PI_LDUR
This request obtains the performance data of a port.	PD_PTC records	GET	/<application>/v1/objects/RAID_PD_PTC	Obtaining performance data
	PI_MPTS records	GET	/<application>/v1/objects/RAID_PI_MPTS
	PI_PTS records	GET	/<application>/v1/objects/RAID_PI_PTS
	PI_PTSX records	GET	/<application>/v1/objects/RAID_PI_PTSX
This request obtains the performance data of a parity group.	PD_RGC records	GET	/<application>/v1/objects/RAID_PD_RGC	Obtaining performance data
	PI_EVGS records	GET	/<application>/v1/objects/RAID_PI_EVGS
	PI_RGS records	GET	/<application>/v1/objects/RAID_PI_RGS
	PI_RGSX records	GET	/<application>/v1/objects/RAID_PI_RGSX
This request obtains the performance data of a storage system.	PD records	GET	/<application>/v1/objects/RAID_PD	Obtaining performance data
	PD_PDX records	GET	/<application>/v1/objects/RAID_PD_PDX
	PI records	GET	/<application>/v1/objects/RAID_PI
	PI_LDA records	GET	/<application>/v1/objects/RAID_PI_LDA
	PI_SCPS records	GET	/<application>/v1/objects/RAID_PI_SCPS
	PI_SCS records	GET	/<application>/v1/objects/RAID_PI_SCS
This request obtains the performance data of a cache logical partition (CLPR).	PD_CLPC records	GET	/<application>/v1/objects/RAID_PD_CLPC	Obtaining performance data
	PI_CLPS records	GET	/<application>/v1/objects/RAID_PI_CLPS	Obtaining performance data
This request obtains the performance data of CLPR Per MP Blade.	PI_CLMS records	GET	/<application>/v1/objects/RAID_PI_CLMS	Obtaining performance data
This request obtains the performance data of a processor.	PD_UMS records	GET	/<application>/v1/objects/RAID_PD_UMS	Obtaining performance data
This request obtains the performance data of a processor.	PI_PRCS records	GET	/<application>/v1/objects/RAID_PI_PRCS	Obtaining performance data
This request obtains the performance data of a channel adapter (CHA).	PI_CHS records	GET	/<application>/v1/objects/RAID_PI_CHS	Obtaining performance data
	PI_CHDR records	GET	/<application>/v1/objects/RAID_PI_CHDR	Obtaining performance data
This request obtains the performance data of a journal group.	PI_JNLS records	GET	/<application>/v1/objects/RAID_PI_JNLS	Obtaining performance data
	PI_JNLX records	GET	/<application>/v1/objects/RAID_PI_JNLX	Obtaining performance data
This request obtains the performance data of a pool.	PD_PLC records	GET	/<application>/v1/objects/RAID_PD_PLC	Obtaining performance data
	PD_PLF records	GET	/<application>/v1/objects/RAID_PD_PLF
	PD_PLR records	GET	/<application>/v1/objects/RAID_PD_PLR
	PI_PLS records	GET	/<application>/v1/objects/RAID_PI_PLS
This request obtains the performance data of a V-VOL.	PD_VVC records	GET	/<application>/v1/objects/RAID_PD_VVC	Obtaining performance data
This request obtains the performance data of a V-VOL.	PD_VVF records	GET	/<application>/v1/objects/RAID_PD_VVF	Obtaining performance data
This request obtains the performance data of a tier (pool).	PD_PLTC records	GET	/<application>/v1/objects/RAID_PD_PLTC	Obtaining performance data
	PD_PLTR records	GET	/<application>/v1/objects/RAID_PD_PLTR
	PD_PLTS records	GET	/<application>/v1/objects/RAID_PD_PLTS
	PI_PLTI records	GET	/<application>/v1/objects/RAID_PI_PLTI
This request obtains the performance data of a tier (V-VOL).	PD_VVTC records	GET	/<application>/v1/objects/RAID_PD_VVTC	Obtaining performance data
	PI_VVTI records	GET	/<application>/v1/objects/RAID_PI_VVTI	Obtaining performance data
This request obtains the performance data indicating the ratio of the total saving effect (excluding system data) achieved by accelerated compression, capacity saving, snapshot, and Dynamic Provisioning.	PD_PEFF records	GET	/<application>/v1/objects/RAID_PD_PEFF	Obtaining performance data
	PD_SEFF records	GET	/<application>/v1/objects/RAID_PD_SEFF	Obtaining performance data
This request obtains the performance data of a virtual storage machine.	PI_VSMS records	GET	/<application>/v1/objects/RAID_PI_VSMS	Obtaining performance data
This request obtains the performance data of access paths.	PI_CCMS records	GET	/<application>/v1/objects/RAID_PI_CCMS	Obtaining performance data
	PI_CHAC records	GET	/<application>/v1/objects/RAID_PI_CHAC
	PI_DKAC records	GET	/<application>/v1/objects/RAID_PI_DKAC
	PI_MPCS records	GET	/<application>/v1/objects/RAID_PI_MPCS
This request obtains the performance data of disk adapters.	PI_DKDR records	GET	/<application>/v1/objects/RAID_PI_DKDR	Obtaining performance data
This request obtains the performance data of disk adapters.	PI_HBAS records	GET	/<application>/v1/objects/RAID_PI_HBAS	Obtaining performance data
Other APIs
This request obtains a list of RAID Agent management actions.		GET	/<application>/v1/services/AgentManager/actions	Obtaining a list of RAID Agent administrative actions
This request obtains the detailed version information of the API.		GET	/<application>/v1/configuration/Version	Obtaining the detailed version information of the API
This request obtains metadata of the `Collection` object.		GET	/<application>/v1/domain-types/Collection	Obtaining metadata
This request obtains metadata of the `Error` object.		GET	/<application>/v1/domain-types/Error
This request obtains metadata of the `Version` object.		GET	/<application>/v1/domain-types/Version
This request obtains metadata of the `Action` object.		GET	/<application>/v1/domain-types/Action
This request obtains metadata of the `Job` object.		GET	/<application>/v1/domain-types/Job
This request obtains metadata of the `Agents` object.		GET	/<application>/v1/domain-types/Agents
This request obtains metadata of the `AgentForRAID` object.		GET	/<application>/v1/domain-types/AgentForRAID
Notes: Outputs the record information corresponding to the type of object specified in object-type under the objects domain. Whether performance information can be acquired differs depending on the Access Type. For details, see Types of performance information that can be acquired depending on the Access Type.