Read list of Virtual Networks with their health summary - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Read list of Virtual Networks with their health summary","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"readListOfVirtualNetworksWithTheirHealthSummary","tags":["SDA"],"summary":"Read list of Virtual Networks with their health summary","deprecated":false,"description":"Get a paginated list of Virtual Networks with health summary. Layer 2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. Please find INFRA_VN related health metrics under /data/api/v1/fabricSiteHealthSummaries (Ex: attributes ‘pubsubInfraVnGoodHealthPercentage’ and ‘bgpPeerInfraVnScoreGoodHealthPercentage’).\n\nThis API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.\n\nFor detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-virtualNetworkHealthSummaries-1.0.1-resolved.yaml\n","parameters":[{"name":"X-CALLER-ID","description":"Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It's an optional header parameter that can be added to an API request.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A field within the response to sort by.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"The sort order of the field ascending or descending.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"id","description":"The list of entity Uuids. (Ex.\"6bef213c-19ca-4170-8375-b694e251101c\")\nExamples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested)\nid=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with '&' separator)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"vnLayer","description":"VN Layer information covering Layer 3 or Layer 2 VNs.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"The interested fields in the request. For valid attributes, verify the documentation.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific health data summaries associated with virtual networks.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchy","description":"The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named \"Global\" (Ex. `Global/AreaName/BuildingName/FloorName`) This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*` Examples: `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"SiteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Virtual networks summmary response covering all virtual networks and their health.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"vlan":{"type":"string","description":""},"vnid":{"type":"string","description":""},"layer":{"type":"string","description":""},"associatedL3Vn":{"type":"string","description":""},"totalEndpoints":{"type":"integer","description":""},"totalFabricSites":{"type":"integer","description":""},"goodHealthPercentage":{"type":"number","description":""},"goodHealthDeviceCount":{"type":"integer","description":""},"totalHealthDeviceCount":{"type":"integer","description":""},"fairHealthDeviceCount":{"type":"integer","description":""},"poorHealthDeviceCount":{"type":"integer","description":""},"noHealthDeviceCount":{"type":"integer","description":""},"vnFabricControlPlaneGoodHealthPercentage":{"type":"number","description":""},"vnFabricControlPlaneTotalDeviceCount":{"type":"integer","description":""},"vnFabricControlPlaneGoodHealthDeviceCount":{"type":"integer","description":""},"vnFabricControlPlanePoorHealthDeviceCount":{"type":"integer","description":""},"vnFabricControlPlaneFairHealthDeviceCount":{"type":"integer","description":""},"vnFabricControlPlaneNoHealthDeviceCount":{"type":"integer","description":""},"vnServicesHealthPercentage":{"type":"number","description":""},"vnServicesTotalDeviceCount":{"type":"integer","description":""},"vnServicesGoodHealthDeviceCount":{"type":"integer","description":""},"vnServicesPoorHealthDeviceCount":{"type":"integer","description":""},"vnServicesFairHealthDeviceCount":{"type":"integer","description":""},"vnServicesNoHealthDeviceCount":{"type":"integer","description":""},"vnExitHealthPercentage":{"type":"number","description":""},"vnExitTotalDeviceCount":{"type":"integer","description":""},"vnExitGoodHealthDeviceCount":{"type":"integer","description":""},"vnExitPoorHealthDeviceCount":{"type":"integer","description":""},"vnExitFairHealthDeviceCount":{"type":"integer","description":""},"vnExitNoHealthDeviceCount":{"type":"integer","description":""},"vnStatusHealthPercentage":{"type":"number","description":""},"vnStatusTotalDeviceCount":{"type":"integer","description":""},"vnStatusGoodHealthDeviceCount":{"type":"integer","description":""},"vnStatusPoorHealthDeviceCount":{"type":"integer","description":""},"vnStatusFairHealthDeviceCount":{"type":"integer","description":""},"vnStatusNoHealthDeviceCount":{"type":"integer","description":""},"pubsubSessionGoodHealthPercentage":{"type":"number","description":""},"pubsubSessionTotalDeviceCount":{"type":"integer","description":""},"pubsubSessionGoodHealthDeviceCount":{"type":"integer","description":""},"pubsubSessionPoorHealthDeviceCount":{"type":"integer","description":""},"pubsubSessionFairHealthDeviceCount":{"type":"integer","description":""},"pubsubSessionNoHealthDeviceCount":{"type":"integer","description":""},"multiCastGoodHealthPercentage":{"type":"number","description":""},"multiCastTotalDeviceCount":{"type":"integer","description":""},"multiCastGoodHealthDeviceCount":{"type":"integer","description":""},"multiCastPoorHealthDeviceCount":{"type":"integer","description":""},"multiCastFairHealthDeviceCount":{"type":"integer","description":""},"internetAvailGoodHealthPercentage":{"type":"number","description":""},"internetAvailTotalDeviceCount":{"type":"integer","description":""},"internetAvailGoodHealthDeviceCount":{"type":"integer","description":""},"internetAvailPoorHealthDeviceCount":{"type":"integer","description":""},"internetAvailFairHealthDeviceCount":{"type":"integer","description":""},"internetAvailNoHealthDeviceCount":{"type":"integer","description":""},"bgpPeerGoodHealthPercentage":{"type":"number","description":""},"bgpPeerTotalDeviceCount":{"type":"integer","description":""},"bgpPeerGoodHealthDeviceCount":{"type":"integer","description":""},"bgpPeerPoorHealthDeviceCount":{"type":"integer","description":""},"bgpPeerFairHealthDeviceCount":{"type":"integer","description":""},"bgpPeerNoHealthDeviceCount":{"type":"integer","description":""},"vniGoodHealthPercentage":{"type":"number","description":""},"vniTotalDeviceCount":{"type":"integer","description":""},"vniGoodHealthDeviceCount":{"type":"integer","description":""},"vniPoorHealthDeviceCount":{"type":"integer","description":""},"vniFairHealthDeviceCount":{"type":"integer","description":""},"vniNoHealthDeviceCount":{"type":"integer","description":""},"networkProtocol":{"type":"string","description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/ReadListOfVirtualNetworksWithTheirHealthSummaryResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"95a0-580c-422a-bd8b","x-rapi-overview":"Get a paginated list of Virtual Networks with health summary. Layer 2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. Please find INFRA_VN related health metrics under /data/api/v1/fabricSiteHealthSummaries (Ex: attributes ‘pubsubInfraVnGoodHealthPercentage’ and ‘bgpPeerInfraVnScoreGoodHealthPercentage’).\n\nThis API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.\n\nFor detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-virtualNetworkHealthSummaries-1.0.1-resolved.yaml\n","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/virtualNetworkHealthSummaries","x-rapi-publicPath":"/dna/data/api/v1/virtualNetworkHealthSummaries","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"readListOfVirtualNetworksWithTheirHealthSummary","method":"get","path":"/dna/data/api/v1/virtualNetworkHealthSummaries"}}