Topology Map

Topology Map

Returns the list of nodes and edges for given class name and instance.

Request
URI
POST
https://{api_host}/tcsa/api/topology/v1/map
COPY
Request Body

Request object to get the map details.

MapInput of type(s) application/json
Required 
{
    "MapType": "VRAN Connectivity",
    "hop": 1,
    "name": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
    "type": "NetworkFunction"
}
string
MapType
Required
Constraints: default:

Map type such as SDN Controller Infrastructure Map

integer
hop
Required
Constraints: default: 0

Number of levels to traverse

string
name
Required
Constraints: default:

Uniquely identifies the object across domains.

string
type
Required
Constraints: default:

Device type such as Router

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TopologyMapResponse of type(s) application/json 
{
    "Edge": {
        "Edges_INCHARGE_SA_PRES/12013412": {
            "_key": "12013412",
            "_id": "Edges_INCHARGE_SA_PRES/12013412",
            "_rev": "_et3-9La--B",
            "_from": "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
            "_to": "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "relName": "Realizes",
            "srcType": "KubernetesPod",
            "trgtType": "NetworkFunction",
            "properties": {
                "DisplayName": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES Realizes NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
                "dest": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
                "discoveryID": "INCHARGE-SA-PRES",
                "jobId": "1662122789071",
                "source": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES"
            }
        },
        "Edges_INCHARGE_SA_PRES/8018585": {
            "_key": "8018585",
            "_id": "Edges_INCHARGE_SA_PRES/8018585",
            "_rev": "_et3ArLe--B",
            "_from": "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "_to": "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
            "relName": "RealizedBy",
            "srcType": "NetworkFunction",
            "trgtType": "KubernetesPod",
            "properties": {
                "DisplayName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES RealizedBy KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
                "dest": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
                "discoveryID": "INCHARGE-SA-PRES",
                "jobId": "1662122789071",
                "source": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES"
            }
        }
    },
    "Node": {
        "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES": {
            "_id": "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
            "discoveryID": "INCHARGE-SA-PRES",
            "name": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf",
            "type": "KubernetesPod",
            "properties": {
                "DeviceType": null,
                "DisplayName": "kube-multus-ds-amd64-gv429",
                "IsABR": null,
                "IsASBR": null,
                "Name": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf",
                "ServiceType": null
            },
            "elementUUID": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
            "elementUUID_PM": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$",
            "isExpandable": true
        },
        "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES": {
            "_key": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "_id": "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "_rev": "_et3ArLa--_",
            "source": "INCHARGE-SA-PRES",
            "discoveryID": "INCHARGE-SA-PRES",
            "name": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
            "creationDate": "2022-09-02T12:52:40Z",
            "lastUpdationDate": "2022-09-02T12:52:40Z",
            "type": "NetworkFunction",
            "properties": {
                "CreationClassName": "NetworkFunction",
                "Description": "",
                "DisplayClassName": "NetworkFunction",
                "DisplayName": "kube-multus-ds-amd64-gv429",
                "IsEdgeHavingProblem": false,
                "IsManaged": true,
                "IsServiceDysFunctional": false,
                "IsVMHostUnResponsive": false,
                "Name": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
                "ServiceKey": "",
                "ServiceName": "",
                "SystemName": ""
            },
            "deviceType": "NetworkFunction",
            "elementUUID": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "elementUUID_PM": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$",
            "jobId": "1662122789071",
            "isExpandable": false
        }
    },
    "NodeCount": 2,
    "isExpandable": true
}
number
NodeCount
Optional

Node count of device

boolean
isExpandable
Optional

Children of device

object
Edge
Optional

Edge type objects

object
Node
Optional

Node type objects


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"MapType:"string","type:"string","name:"string","hop:"integer"}' https://{api_host}/tcsa/api/topology/v1/map
On This Page
Topology Operations
POST
Get Class Types
POST
Get Map Types
POST
Get Instances
POST
Get Relationships
POST
Topology Map
POST
Get Domain Managers