Get Mapping Summary - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Mapping Summary","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["MultiCloud - Mapping"],"description":"Get mapping summary","operationId":"getMappingSummary","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"vpnTunnelStatus","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"Account ID":{"type":"object","properties":{"Site To Cloud NCC Hub Name":{"type":"string"},"Site To Cloud NCC Spoke Name":{"type":"string"},"Site To Cloud Primary GCR Name":{"type":"string"},"Site To Cloud VPC ID":{"type":"string"},"Site To Cloud VPC Name":{"type":"string"},"Site To Site NCC Hub Name":{"type":"string"},"Site To Site VPC ID":{"type":"string"},"Site To Site VPC Name":{"type":"string"},"WAN VPC ID":{"type":"string"},"WAN VPC Name":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryAccountID"},"Azure Virtual WAN Hub ID":{"type":"string"},"accountName":{"type":"string"},"additionalDetails":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderMgmtReference":{"type":"string"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"string"},"devices":{"type":"array","items":{"type":"object","properties":{"reachability":{"type":"string"},"systemIp":{"type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryDevices"}},"hostVpcs":{"type":"object","properties":{"accountId":{"type":"string"},"hostVpcId":{"type":"string"},"tag":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryHostVpcs"},"operState":{"type":"string"},"region":{"type":"string"},"status":{"type":"string"},"tags":{"type":"object","properties":{"tag":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryTags"},"tgwRouteTableId":{"type":"string"},"tunnels":{"type":"array","items":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryTunnels"}},"vpns":{"type":"object","properties":{"vpnId":{"type":"string"}},"$$ref":"#/components/schemas/MapSummaryVpns"}},"$$ref":"#/components/schemas/MapSummary"}},"examples":{"Get GCP Map Summary":{"description":"Get GCP Map Summary","value":{"region":"us-west2","accountName":"pp-acc","cloudType":"GCP","cloudGatewayName":"cgw1-gcp","cloudGatewaySolution":"gcp","cloudProviderMgmtReference":"NA","connectivityState":"Successful","connectivityStateUpdateTs":"1660614410162","additionalDetails":[{"Account ID":"gcp-abc-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"uuid":"C8K-4ABB877C-519B-5186-B271-5698961952F4","systemIp":"101.1.1.7","reachability":"reachable"},{"uuid":"C8K-495C4EB7-0813-01F2-06E1-2BFBE1C15965","systemIp":"101.1.1.6","reachability":"reachable"}],"status":"normal,","connectedSites":"1,","vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4ABB877C-519B-5186-B271-5698961952F4::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.40","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-pp-nprd-10202","tag":"tag1"},{"hostVpcId":"5752708641463555655","accountId":"gcp-pp-nprd-10202","tag":"tag1"}],"operState":""}},"Get AWS Map Summary":{"description":"Get AWS Map Summary","value":{"region":"us-west-1","accountName":"sdwan-pp","cloudType":"AWS","cloudGatewayName":"awstest","cloudGatewaySolution":"tgw_tvpc","cloudProviderMgmtReference":"arn:aws:networkma380167:global-network","connectivityState":"Successful","connectivityStateUpdateTs":"1661542265017","additionalDetails":[{"Account ID":"845888380167"},{"Transit Gateway ID":"tgw-0dd6167696ff9"},{"TGW Route Table Count":"2"},{"Transit VPC ID":"vpc-09f7ce0e792d78e73"},{"Transit VPC Name":"awscgwtest"}],"devices":[{"uuid":"C8K-09f782-bc71-4f91-9673-cfeea2f8f235","systemIp":"203.1.1.1","reachability":"reachable"}],"status":"normal","connectedSites":1,"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-09f76182-bc71-4f91-9673-cfeea2f8f235::100","tunnelInnerIps":["169.254.0.76/30","169.254.0.80/30"],"status":"DOWN","statusMessage":"IPSEC IS DOWN","outerIpAddr":"52.53.91.70","acceptedRouteCount":0,"lastStatusChangeTimestamp":"1660986000"}],"tags":[{"tag":"tagtest"}],"hostVpcs":[{"hostVpcId":"vpc-0445ecc99eecdf","accountId":"845888380167","tag":"tagtest"}],"operState":""}},"Get Azure Map Summary":{"description":"Get Azure Map Summary","value":{"region":"westcentralus","accountName":"pp-azure","cloudType":"AZURE","cloudGatewayName":"AzureCGW","connectivityState":"Successful","connectivityStateUpdateTs":"16606410162","additionalDetails":[{"Account ID":"aws-pp-nprd-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"status":"normal"},{"connectedSites":1}],"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-shabshargcp-nprd-10202","tag":"tag1"}],"operState":""}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/multicloud/map/summary"}}