[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Topology Map
DescriptionReturns the list of nodes and edges for given class name and instance.
Request
URLURL
https://{api_host}tcsa.host.com/tcsa/api/topology/v1/map
Request Body
Request Body
{
"MapType": "VRAN Connectivity",
"hop": 1,
"name": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
"type": "NetworkFunction"
}
string
MapType
Required
Map type such as SDN Controller Infrastructure Map
integer
hop
Required
Number of levels to traverse
string
name
Required
Uniquely identifies the object across domains.
string
type
Required
Device type such as Router
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
TopologyMapResponse
of type application/json
{
"Edge": {
"Edges_INCHARGE_SA_PRES/12013412": {
"_from": "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
"_id": "Edges_INCHARGE_SA_PRES/12013412",
"_key": "12013412",
"_rev": "_et3-9La--B",
"_to": "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
"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"
},
"relName": "Realizes",
"srcType": "KubernetesPod",
"trgtType": "NetworkFunction"
},
"Edges_INCHARGE_SA_PRES/8018585": {
"_from": "Nodes_INCHARGE_SA_PRES/NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
"_id": "Edges_INCHARGE_SA_PRES/8018585",
"_key": "8018585",
"_rev": "_et3ArLe--B",
"_to": "Nodes_INCHARGE_SA_PRES/KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
"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"
},
"relName": "RealizedBy",
"srcType": "NetworkFunction",
"trgtType": "KubernetesPod"
}
},
"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",
"elementUUID": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$INCHARGE-SA-PRES",
"elementUUID_PM": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf$KubernetesPod$",
"isExpandable": true,
"name": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf",
"properties": {
"DeviceType": null,
"DisplayName": "kube-multus-ds-amd64-gv429",
"IsABR": null,
"IsASBR": null,
"Name": "KubernetesPod-569b3e3c-2734-4877-ae4a-7b504a5058cf",
"ServiceType": null
},
"type": "KubernetesPod"
},
"Nodes_INCHARGE_SA_PRES/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",
"_key": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
"_rev": "_et3ArLa--_",
"creationDate": "2022-09-02T12:52:40Z",
"deviceType": "NetworkFunction",
"discoveryID": "INCHARGE-SA-PRES",
"elementUUID": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
"elementUUID_PM": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$",
"isExpandable": false,
"jobId": "1662122789071",
"lastUpdationDate": "2022-09-02T12:52:40Z",
"name": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
"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": ""
},
"source": "INCHARGE-SA-PRES",
"type": "NetworkFunction"
}
},
"NodeCount": 2,
"isExpandable": true
}
number
NodeCount
Optional
Node count of device
boolean
isExpandable
Optional
Children of device
Errors
400
Invalid Request sent by the user
401
User authentication failed
403
Access to the requested resource/operation is forbidden
404
Cannot find requested resource
500
Internal server error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"MapType":"VRAN Connectivity","hop":1,"name":"NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES","type":"NetworkFunction"}' https://{api_host}tcsa.host.com/tcsa/api/topology/v1/map
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: request
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
On This Page
Topology Operations
post
post
post
post
post
post
