Getting resource information

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain information about a specific resource, such as the resource name.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/E2EView/actions/getNodeList/invoke

Request body

The structure of the request body and the object attributes are as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the action.
href	string	URL for the action.
method	string	Name of the method.
type	string	Data format for the object.
parameters	anyType[]	A list of GetNodeListParam objects necessary to execute an operation. For details, see the table below.

GetNodeListParam

{
        "resourceIDs":["...", ...]
}

GetNodeListParam (Type: GetNodeListParam)

Attribute	Type	Description
resourceIDs	string[]	ID of the resource

Response body

The structure of the response body and the object attributes is as follows:

E2ENodeList

{
        "resources":[{
            "nodeName":"...",
            "nodeType":"...",
            "componentID":"...",
            "componentName":"...",
            "componentType":"..."
        },
        :
        ]
}

E2ENodeList (Type: E2ENodeList)

Attribute	Type	Description
resources	E2ENodeName[]	Resource

resources (Type: E2ENodeName)

Attribute	Type	Description
nodeName	string	Name of the resources that are managed by Ops Center Analyzer
nodeType	enum	Type of the resources that are managed by Ops Center Analyzer (For details about the valid values, see the table NodeDisplayType in List of enumerators.) Unknown Server Storage NetworkDevice Datastore
componentID	string	ID of the component
componentName	string	Name of the component
componentType	enum	Type of the component (For details about the valid values, see the table ComponentType in List of enumerators.) CPU MEMORY LAN_PORT FC_HBA_PORT DISK_DRIVE FILE_SYSTEM STORAGE_CONTROLLER STORAGE_FC_PORT STORAGE_POOL STORAGE_VOLUME STORAGE_CACHE VIRTUAL_MACHINE HYPERVISOR_CLUSTER STORAGE_MPB STORAGE_DP_POOL

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
404	Not Found	Number of obtained items: 0
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
POST Analytics/v1/services/E2EView/actions/getNodeList/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name" : "getNodeList",
  "href" : "http://localhost:22015/Analytics/v1/services/E2EView/actions/getNodeList/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters": [
    {
      "resourceIDs": [
      "raidLdev#51547-00^00^00", "raidLdev#410438-00^00^00", "raidLdev#51306-00^00^00"
      ]
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Cache-Control: no-cache
Connection: Keep-Alive
Content-Type: application/json
Date: Tue, 24 Jan 2017 01:20:00 GMT
Server: Cosminexus HTTP Server
Transfer-Encoding: chunked
WWW-Authenticate: HSSO c450462eec01893d4c1ebcba7e7876538bd94_VwBvNGpyDgxyCUY3eXZdCQ==_V0810
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection : 1; mode=block


[Response Body]
{
  "instanceID": "9a277dd5-5016-4a03-ba87-ac6ccc9de566",
  "created": "2017-01-24T10:20:00.820+09:00",
  "updated": "2017-01-24T10:20:00.820+09:00",
  "completed": "2017-01-24T10:20:00.820+09:00",
  "state": "success",
  "affectedResource": [],
  "result": [
    {
      "resources": [
        {
          "instanceID": "raidStorage#410438",
          "nodeName": "VSP G400/G600 (410438)",
          "nodeType": "Storage",
          "componentID": "raidLdev#410438-00^00^00",
          "componentName": "00:00:00"
        },
        {
          "instanceID": "raidStorage#51306",
          "nodeName": "XP7 (51306)",
          "nodeType": "Storage",
          "componentID": "raidLdev#51306-00^00^00",
          "componentName": "00:00:00"
        },
        {
          "instanceID": "raidStorage#51547",
          "nodeName": "VSP G1500 (51547)",
          "nodeType": "Storage",
          "componentID": "raidLdev#51547-00^00^00",
          "componentName": "00:00:00"
        }
      ]
    }
  ]
}