Getting a list of resources related to the E2E views

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of resources related to a specific resource displayed in the Analyze Bottleneck view.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/E2EView/actions/getRelatedNodeList/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 E2EViewParam objects necessary to execute an operation. For details, see the table below.

E2EViewParam

{
        "basePointNodeID":["...", ...],
        "basePointNodeType":"..."
}

E2EViewParam (Type: E2EViewParam)

Attribute	Type	Description
basePointNodeID	string[]	ID of the base resource. Multiple IDs can be specified if the resources are of the same type.
basePointNodeType	enum	Type of base resource (For details about the valid values, see the table E2ENodeType in List of enumerators.)

Attribute

Type

Description

basePointNodeID

string[]

ID of the base resource. Multiple IDs can be specified if the resources are of the same type.

basePointNodeType

enum

Type of base resource

(For details about the valid values, see the table E2ENodeType in List of enumerators.)

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of Collections objects. For details, see the table below.

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	Collections resource list containing the following Collections resources that have the following structure: { "<E2ENodeType>": Collections }
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

Attribute

Type

Description

data

anyType[]

Collections resource list containing the following Collections resources that have the following structure:

{

"<E2ENodeType>": Collections

}

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of E2ETopologyNode objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

E2ETopologyNode

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "relatedNodeList":[{
            "instanceID":"...",
            "type":"...",
            "componentType":"...",
            "profileResourceType":"..."
        },
        :
        ],
        "shareRate":"...",
        "profileResourceType":"...",
        "driveStatus":"..."
}

E2ETopologyNode (Type: E2ETopologyNode)

Attribute	Type	Description
instanceID	string	ID of the resource
name	string	Name of the resource
status	enum	Status of the resource (For details about the valid values, see the table E2ENodeStatus in List of enumerators.)
relatedNodeList	E2ETopologyRelatedNode[]	Information about related resources
shareRate	int	Percentage of related base point resources out of all the base point resources. (Note: The Share Rate value is not available when you set a Hypervisor or Storage System as the base point of analysis.)
profileResourceType	enum	Resource type of the profile (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
driveStatus	string	Aggregated drive status of all data drives that configure the parity group

relatedNodeList (Type: E2ETopologyRelatedNode)

Attribute	Type	Description
instanceID	string	ID of the resource.
type	enum	Device type of the resource. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
componentType	enum	Component type of the resource. (For details about the valid values, see the table ComponentType in List of enumerators.)
profileResourceType	enum	Type of the profile. (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)

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.
412	Precondition Failed	- The server is not available. - The threshold of a query parameter exceeded.
500	Internal Server Error	Server processing error.
503	Service Unavailable	Analyzer detail view server communication error.

Example code

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

[Request Body]
{
  "name": "getRelatedNodeList",
  "href": "http://localhost:22015/Analytics/v1/services/E2EView/actions/getRelatedNodeList/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "basePointNodeID":["h#ABC_172.17.17.115_host-195"],
    "basePointNodeType":"HYPERVISOR"
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:51:55 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : "ef8ef038-cca2-41f1-9a8b-d5cadedb8e37",
  "created" : "2016-07-20T11:51:58.740+09:00",
  "updated" : "2016-07-20T11:51:58.740+09:00",
  "completed" : "2016-07-20T11:51:58.740+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "DISK" : [ {
      "instanceID" : "disk#ABC_172.17.17.115_host-195^mpx.vmhba1^C0^T0^L0",
      "name" : "mpx.vmhba1:C0:T0:L0",
      "status" : "UNKNOWN",
      "relatedNodeList" : [ {
        "instanceID" : "vdisk#ABC_172.17.17.115_vm-198^2000",
        "type" : "VIRTUAL_MACHINE",
        "componentType" : "VIRTUAL_DISK",
        "profileResourceType" : "ESX_VM"
      }, {
      ...........
      } ],
      "shareRate" : 100,
      "profileResourceType" : "ESX"
    } ],
    "VIRTUAL_MACHINE" : [ {
      "instanceID" : "vm#ABC_172.17.17.115_vm-350",
      "name" : "CT5_DT005_e",
      "status" : "UNKNOWN",
      "relatedNodeList" : [ {
        "instanceID" : "cpu#ABC_172.17.17.115_host-195^2",
        "type" : "CPU",
        "componentType" : "CPU",
        "profileResourceType" : "ESX"
      }, {
      ..........
      } ],
      "shareRate" : 100,
      "profileResourceType" : "ESX_VM"
    }, {
    ..........
  } ]
}