Getting a list of resources that are displayed in the E2E view

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of resources displayed in the E2E view.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/E2EView?basePointNodeType={E2ENodeType}&basePointNodeID={nodeID}&targetNodeType={E2ENodeType}&parentNodeID={nodeID}&page={page}&pageSize={size}

Query parameters

The following table describes the values for the supported parameters of a query string:

Parameter	Description
basePointNodeType={E2ENodeType}	(Required) Specify the E2E node type. Filtering conditions: Checks whether the comparison target is equal to the value
basePointNodeID={nodeID}	(Required) Specify 1 or more base node IDs. Filtering conditions: Checks whether the value is included in the comparison target. Multiple values separated by a comma (,) can be specified.
targetNodeType={E2ENodeType}	(Required) Specify the E2E node type. Filtering conditions: Checks whether the comparison target is equal to the value
parentNodeID={nodeID}	(Optional) Specify 0 or more node IDs. Filtering conditions: Checks whether the value is included in the comparison target. Multiple values separated by a comma (,) can be specified.
page={page}	(Optional) Specify the paging information (page to be obtained). Filtering conditions: Checks whether the comparison target is equal to the value
pageSize={size}	(Optional) Specify the number of items that can be displayed on 1 page. Filtering conditions: Checks whether the comparison target is equal to the value

Request body

Not applicable.

Response body

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

Collections

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

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of E2ENode 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.

E2ENode

{
        "instanceID":"...",
        "name":"...",
        "type":"...",
        "status":"...",
        "consumerName":"...",
        "gradeName":"...",
        "gradeOrder":"...",
        "additional":"...",
        "parentID":"...",
        "parentType":"...",
        "description":"...",
        "label":"...",
        "nvmHostNicknames":["...", ...],
        "hostGroupIDs":["...", ...],
        "hostGroupNames":["...", ...],
        "lunOwnerIDs":["...", ...],
        "lunOwnerNames":["...", ...],
        "poolSavingRatio":"...",
        "datastoreType":"...",
        "datastoreCapacity":"..."
}

E2ENode (Type: E2ENode)

Attribute	Type	Description
instanceID	string	ID of the resource.
name	string	Name of the resource.
type	enum	Type of the resource. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
status	enum	Status of the resource. (For details about the valid values, see the table NodeStatusType in List of enumerators.) Normal Warning Critical Unknown
consumerName	string	Name of the consumer.
gradeName	string	Name of the grade.
gradeOrder	int	Priority of the grade.
additional	string	Additional information.
parentID	string	ID of the parent resource that a resource belongs to.
parentType	enum	Type of parent resource that a resource belongs to. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
description	string	Description of the resource.
label	string	Label of the volume.
nvmHostNicknames	string[]	NVM host nickname of the volume.
hostGroupIDs	string[]	ID of the host group that a volume belongs to.
hostGroupNames	string[]	Type of host group that a volume belongs to.
lunOwnerIDs	string[]	ID of the LUN owner that a volume is associated with.
lunOwnerNames	string[]	Name of the LUN owner that a volume is associated with.
poolSavingRatio	float	The capacity savings ratio with the controller-based capacity saving and accelerated compression features in a pool.
datastoreType	string	Type of datastore.
datastoreCapacity	float	Capacity of the datastore.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	A query parameter 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]
GET /Analytics/v1/objects/E2EView/?basePointNodeID[]=h%23ABC_172.17.17.115_host-195&basePointNodeType=HYPERVISOR&targetNodeType=CPU&parentNodeID=h%23ABC_172.17.17.115_host-195
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:51:48 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]
{
  "data" : [ {
    "instanceID" : "cpu#ABC_172.17.17.115_host-195^0",
    "name" : "Intel(R) Xeon(R) CPU E5-2670 0 @ 2.60GHz#0",
    "type" : "CPU",
    "status" : "Unknown",
    "additional" : "172.17.17.181",
    "parentID" : "h#ABC_172.17.17.115_host-195",
    "parentType" : "HYPERVISOR"
  }, {
  ........
  } ],
  "count" : 8
}