Getting topology data for 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 the topology data of resources displayed in the E2E view.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/E2EView/actions/getTopologyData/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.)

Response body

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

E2ETopologyData

{
        "basePointNodeName":"...",
        "hasHighlightData":"...",
        "customer":{
            "count":"...",
            "customerGradeList":[{
                "name":"...",
                "order":"...",
                "customers":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "shareRate":"...",
                    "profileResourceType":"...",
                    "driveStatus":"..."
                },
                :
                ]
            },
            :
            ]
        },
        "server":{
            "count":"...",
            "clusterList":[{
                "instanceID":"...",
                "name":"...",
                "hypervisors":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "hosts":[{
                        "instanceID":"...",
                        "name":"...",
                        "status":"...",
                        "relatedNodeList":[{
                            "instanceID":"...",
                            "type":"...",
                            "componentType":"...",
                            "profileResourceType":"..."
                        },
                        :
                        ],
                        "shareRate":"...",
                        "profileResourceType":"...",
                        "driveStatus":"..."
                    },
                    :
                    ],
                    "components":[{
                        "name":"...",
                        "type":"...",
                        "items":[{
                            "instanceID":"...",
                            "name":"...",
                            "status":"...",
                            "relatedNodeList":[{
                                "instanceID":"...",
                                "type":"...",
                                "componentType":"...",
                                "profileResourceType":"..."
                            },
                            :
                            ],
                            "shareRate":"...",
                            "profileResourceType":"...",
                            "driveStatus":"..."
                        },
                        :
                        ]
                    },
                    :
                    ],
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "profileResourceType":"..."
                },
                :
                ],
                "relatedNodeList":[{
                    "instanceID":"...",
                    "type":"...",
                    "componentType":"...",
                    "profileResourceType":"..."
                },
                :
                ]
            },
            :
            ],
            "nonclusteredHypervisorList":[{
                "instanceID":"...",
                "name":"...",
                "status":"...",
                "hosts":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "shareRate":"...",
                    "profileResourceType":"...",
                    "driveStatus":"..."
                },
                :
                ],
                "components":[{
                    "name":"...",
                    "type":"...",
                    "items":[{
                        "instanceID":"...",
                        "name":"...",
                        "status":"...",
                        "relatedNodeList":[{
                            "instanceID":"...",
                            "type":"...",
                            "componentType":"...",
                            "profileResourceType":"..."
                        },
                        :
                        ],
                        "shareRate":"...",
                        "profileResourceType":"...",
                        "driveStatus":"..."
                    },
                    :
                    ]
                },
                :
                ],
                "relatedNodeList":[{
                    "instanceID":"...",
                    "type":"...",
                    "componentType":"...",
                    "profileResourceType":"..."
                },
                :
                ],
                "profileResourceType":"..."
            },
            :
            ],
            "otherserverHostList":[{
                "instanceID":"...",
                "name":"...",
                "status":"...",
                "relatedNodeList":[{
                    "instanceID":"...",
                    "type":"...",
                    "componentType":"...",
                    "profileResourceType":"..."
                },
                :
                ],
                "shareRate":"...",
                "profileResourceType":"...",
                "driveStatus":"..."
            },
            :
            ]
        },
        "datastore":{
            "count":"...",
            "datastoreGroupList":[{
                "instanceID":"...",
                "name":"...",
                "datastores":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "shareRate":"...",
                    "profileResourceType":"...",
                    "driveStatus":"..."
                },
                :
                ]
            },
            :
            ]
        },
        "network":{
            "count":"...",
            "sanList":[{
                "instanceID":"...",
                "name":"...",
                "switches":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "shareRate":"...",
                    "profileResourceType":"...",
                    "driveStatus":"..."
                },
                :
                ]
            },
            :
            ]
        },
        "storage":{
            "count":"...",
            "storageList":[{
                "instanceID":"...",
                "name":"...",
                "status":"...",
                "volumes":[{
                    "instanceID":"...",
                    "name":"...",
                    "status":"...",
                    "relatedNodeList":[{
                        "instanceID":"...",
                        "type":"...",
                        "componentType":"...",
                        "profileResourceType":"..."
                    },
                    :
                    ],
                    "shareRate":"...",
                    "profileResourceType":"...",
                    "driveStatus":"..."
                },
                :
                ],
                "components":[{
                    "name":"...",
                    "type":"...",
                    "items":[{
                        "instanceID":"...",
                        "name":"...",
                        "status":"...",
                        "relatedNodeList":[{
                            "instanceID":"...",
                            "type":"...",
                            "componentType":"...",
                            "profileResourceType":"..."
                        },
                        :
                        ],
                        "shareRate":"...",
                        "profileResourceType":"...",
                        "driveStatus":"..."
                    },
                    :
                    ]
                },
                :
                ],
                "relatedNodeList":[{
                    "instanceID":"...",
                    "type":"...",
                    "componentType":"...",
                    "profileResourceType":"..."
                },
                :
                ],
                "profileResourceType":"..."
            },
            :
            ]
        }
}

E2ETopologyData (Type: E2ETopologyData)

Attribute

Type

Description

basePointNodeName

string

Name of the base resource

hasHighlightData

boolean

Whether or not highlight information (information about connections among resources) has already been obtained. If it has already been obtained, "true" is set. If it has not been obtained yet, "false" is set.

customer

E2ECustomerColumn

Information about the consumer arrays

server

E2EServerColumn

Information about the server arrays

datastore

E2EDatastoreColumn

Information about the datastore arrays

network

E2ENetworkColumn

Information about the network arrays

storage

E2EStorageColumn

Information about the storage arrays

customer (Type: E2ECustomerColumn)

Attribute

Type

Description

count

long

Number of consumers

customerGradeList

E2ECustomerGrade[]

Information about the consumers classified by grade

customerGradeList (Type: E2ECustomerGrade)

Attribute

Type

Description

name

string

Name of the grade

order

long

Priority of the grade

customers

E2ETopologyNode[]

Information about the consumers belonging to the grade

customers (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.)

server (Type: E2EServerColumn)

Attribute

Type

Description

count

int

Total number of virtual machines and hosts

clusterList

E2ECluster[]

Information about clustered hypervisors and virtual machines

nonclusteredHypervisorList

E2EHypervisor[]

Information about non-clustered hypervisors and virtual machines

otherserverHostList

E2ETopologyNode[]

Information about the host

clusterList (Type: E2ECluster)

Attribute

Type

Description

instanceID

string

ID of the cluster

name

string

Name of the cluster

hypervisors

E2EHypervisor[]

Hypervisor information related cluster

relatedNodeList

E2ETopologyRelatedNode[]

ID of the related resources

hypervisors (Type: E2EHypervisor)

Attribute

Type

Description

instanceID

string

ID of the hypervisor

name

string

Name of the hypervisor

status

enum

Status of the hypervisor

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

hosts

E2ETopologyNode[]

Information about the virtual machines owned by a hypervisor

components

E2EComponentGroup[]

Information about the components owned by a hypervisor

relatedNodeList

E2ETopologyRelatedNode[]

Information about related resources

profileResourceType

enum

Resource type of the profile

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

hosts (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.)

components (Type: E2EComponentGroup)

Attribute

Type

Description

name

string

Name of the component type

type

enum

Type of the component

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

items

E2ETopologyNode[]

Information about the component

items (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.)

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.)

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.)

nonclusteredHypervisorList (Type: E2EHypervisor)

Attribute

Type

Description

instanceID

string

ID of the hypervisor

name

string

Name of the hypervisor

status

enum

Status of the hypervisor

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

hosts

E2ETopologyNode[]

Information about the virtual machines owned by a hypervisor

components

E2EComponentGroup[]

Information about the components owned by a hypervisor

relatedNodeList

E2ETopologyRelatedNode[]

Information about related resources

profileResourceType

enum

Resource type of the profile

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

hosts (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.)

components (Type: E2EComponentGroup)

Attribute

Type

Description

name

string

Name of the component type

type

enum

Type of the component

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

items

E2ETopologyNode[]

Information about the component

items (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.)

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.)

otherserverHostList (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.)

datastore (Type: E2EDatastoreColumn)

Attribute

Type

Description

count

int

Number of datastores

datastoreGroupList

E2EDatastoreGroup[]

Information about the datastore group

datastoreGroupList (Type: E2EDatastoreGroup)

Attribute

Type

Description

instanceID

string

ID of the datastore group

name

string

Name of the datastore group

datastores

E2ETopologyNode[]

Datastore information related to the datastore group

datastores (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.)

network (Type: E2ENetworkColumn)

Attribute

Type

Description

count

int

Number of switches

sanList

E2ENetwork[]

FC switch list

sanList (Type: E2ENetwork)

Attribute

Type

Description

instanceID

string

ID of the network

name

string

Name of the network

switches

E2ETopologyNode[]

FC switch information

switches (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.)

storage (Type: E2EStorageColumn)

Attribute

Type

Description

count

int

Number of storage systems

storageList

E2EStorage[]

Information about the storage system

storageList (Type: E2EStorage)

Attribute

Type

Description

instanceID

string

ID of the storage system

name

string

Name of the storage system

status

enum

Status of the storage system

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

volumes

E2ETopologyNode[]

Information about the storage system volumes.

components

E2EComponentGroup[]

Information about the storage system components.

relatedNodeList

E2ETopologyRelatedNode[]

Information about related resources

profileResourceType

enum

Resource type of the profile

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

volumes (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.)

components (Type: E2EComponentGroup)

Attribute

Type

Description

name

string

Name of the component type

type

enum

Type of the component

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

items

E2ETopologyNode[]

Information about the component

items (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.)

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/getTopologyData/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name": "getTopologyData",
  "href": "http://localhost:22015/Analytics/v1/services/E2EView/actions/getTopologyData/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:59 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" : "dba6253d-0514-43e3-b63b-8260b37b3cef",
  "created" : "2016-07-20T11:52:01.022+09:00",
  "updated" : "2016-07-20T11:52:01.023+09:00",
  "completed" : "2016-07-20T11:52:01.023+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "basePointNodeName" : "172.17.17.181",
    "hasHighlightData" : true,
    "customer" : {
      "count" : 0,
      "customerGradeList" : [ ]
    },
    "server" : {
      "count" : 11,
      "clusterList" : [ ],
      "nonclusteredHypervisorList" : [ {
        "instanceID" : "h#ABC_172.17.17.115_host-195",
        "name" : "172.17.17.181",
        "status" : "UNKNOWN",
        "hosts" : [ {
          "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"
        }, {
        ............
        } ],
        "components" : [ {
          "name" : "CPU",
          "type" : "CPU",
          "items" : [ {
            "instanceID" : "cpu#ABC_172.17.17.115_host-195^0",
            "name" : "Intel(R) Xeon(R) CPU E5-2670 0 @ 2.60GHz#0",
            "status" : "UNKNOWN",
            "relatedNodeList" : [ {
              "instanceID" : "vm#ABC_172.17.17.115_vm-488",
              "type" : "VIRTUAL_MACHINE",
              "componentType" : "VIRTUAL_MACHINE",
              "profileResourceType" : "ESX_VM"
            }, {
            ..........
            } ],
            "shareRate" : 100,
            "profileResourceType" : "ESX"
          } ]
        }, {
        ........
        } ],
    },
    .............
    "externalStorage" : {
      "count" : 0,
      "storageList" : [ ]
    }
  } ]
}