Obtaining a list of instances without using 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/AgentForRAID

Request structure

Not applicable.

Response structure

The configuration of the response body is as follows:

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

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 `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 AgentForRAID objects.

Variable name	Type	Description
`instanceName`	string	The name of a RAID Agent instance
`hostName`	string	The monitoring host name of the host that runs the RAID Agent
`ipAddr`	string	The IP address of the host on which the RAID Agent is operating
`dataModelVersion`	decimal	This is always set to 0.0.
`lastUpdateTime`	string	The last time the RAID Agent information was successfully updated. The value is set in the extended ISO8601 format (`YYYY`-`MM`-`DD`T`hh`:`mm`:`ss`Z). `hh` is specified in 24-hour format. Z indicates the UTC time.
`storageVendor`	string	The vendor name of the storage system^*
`storageModel`	string	The model name of the storage system^*
`storageSerialNumber`	string	The serial number of the storage system^*
* 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 -X GET https://server_1:22016/Analytics/RAIDAgent/v1/objects/AgentForRAID

Execution result for the request:

Request header

GET /Analytics/RAIDAgent/v1/objects/AgentForRAID HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (i386-redhat-linux-gnu) libcurl/7.19.7
NSS/3.12.9.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2
Host: server_1:22016
Accept: */*

Response header

HTTP/1.1 200 OK
Date: Fri, 20 Jun 2014 12:32:53 GMT
Server: Cosminexus HTTP Server
Last-Modified: Fri, 20 Jun 2014 12:32:14 GMT
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

Response body

{
    "items":[{
        "instanceName":"VSPG1000_instance",
        "hostName":"agent_1",
        "ipAddr":"<IP-address-of-agent_1>",
        "dataModelVersion":0.0,
        "storageVendor":"HITACHI",
        "storageModel":"VSP G1000",
        "storageSerialNumber":"10051",
        "lastUpdateTime":"2014-06-20T12:32:14Z"
                },
              :
              :
                {
        "instanceName":"VSPG1000_instance2",
        "hostName":"agent_2",
        "ipAddr":"<IP-address-of-agent_2>",
        "dataModelVersion":0.0,
        "storageVendor":"HITACHI",
        "storageModel":"VSP G1500",
        "storageSerialNumber":"10052",
        "lastUpdateTime":"2014-06-20T12:32:14Z"
                }]
}