Obtaining a list of instances with a query

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of RAID Agent instances.

HTTP request syntax (URI)

GET <scheme>://<host>:<port>/<application>/<version>/objects/Agents?<query-string>

Query string

Example of specifying the query strings:

agentType=RAID

The following table describes the key and values of the query strings that can be specified when obtaining a list of RAID Agent instances.

Key	Value		Required
Key	Specifiable value	Remarks	Required
`agentType`	Specify "RAID".	The agent type of RAID Agent	Yes

Request structure

Not applicable.

Response structure

The configuration of the response body is as follows:

{
    "items":[{
        "agentType":"RAID",
        "instanceName":"...",
        "hostName":"...",
        "ipAddr":"...",
        "dataModelVersion":...,
        "storageVendor":"...",
        "storageModel":"...",
        "storageSerialNumber":"..."
        "lastUpdateTime":"...",
                },
            :
            :
                ]
}

The following table describes the format of the data included in the response body.

Object name			Number of objects	Description
`Collection`			1	The `Collection` object that is the parent object of `Agents` objects
-	`Agents`		-	Generic name of `AgentForRAID` objects
-	-	`AgentForRAID`	0 to n	`AgentForRAID` objects For details about the schema, see the following table.

The following table lists and describes the schema for the Agents objects.

Variable name	Whether agentType is displayed	Type	Description
`agentType`	Y	string	The agent type of the RAID Agent
`instanceName`	Y	string	The name of a RAID Agent instance
`hostName`	Y	string	The monitoring host name of the host that runs the RAID Agent
`ipAddr`	Y	string	The IP address of the host on which the RAID Agent is running
`dataModelVersion`	Y	decimal	This is always set to 0.0.
`storageVendor`	Y	string	The vendor name of the storage system^*
`storageModel`	Y	string	The model name of the storage system^*
`storageSerialNumber`	Y	string	The serial number of the storage system^*
`lastUpdateTime`	Y	string	The last time the RAID Agent information was successfully updated. The value is set in the extended ISO8601 format (`YYYY`-`MM`-`DD`Thh:mm:ssZ). `hh` is specified in 24-hour format. `Z` indicates the UTC time.
Legend: Y: Displayed
* Virtual storage machines are not included in the storage system being monitored.

Example (obtaining a list of RAID Agent instances)

Request message by using the curl command

curl -v -u system:manager -H Content-Type: application/json -X GET http://server_1:22015/Analytics/RAIDAgent/v1/objects/Agents?agentType=RAID

Execution result for the request:

Request header

GET /Analytics/RAIDAgent/v1/objects/Agents?agentType=RAID HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7
NSS/3.18 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
Host: server_1:22015
Host: :22016
Accept: */*
Content-Type: application/json

Response header

HTTP/1.1 200 OK
Date: Mon, 28 Sep 2015 06:41:14 GMT
Server: Cosminexus HTTP Server
Last-Modified: Mon, 28 Sep 2015 06:41:03 GMT
Cache-Control: no-cache
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

Response body

{
    "items":[{
    "agentType":"RAID",
    "instanceName":"MONITOR1",
    "hostName":"esxi4VM02",
    "ipAddr":"<IP-address-of-MONITOR1>",
    "dataModelVersion":0.0,
    "storageVendor":"HITACHI",
    "storageModel":"VSP G1000",
    "storageSerialNumber":"10051",
    "lastUpdateTime":"2015-09-09T04:47:16Z"
        }]
}