{"type":"api","title":"Calculate CDG requirements for devices and KPIs","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/280afeb1-5ea4-33e3-8618-f92d3ecedf8f","info":{"contact":{"email":"support@cisco.com","name":"Crosswork Team, Cisco"},"description":"Health Insights(HI) is a software system that provides smart KPI monitoring and remediation for service provider networks. This document contains details of the HI RESTful APIs that can be used to manage KPIs, enable/disable KPIs on groups or devices, query KPIs and device alerts, remediate alerting KPIs etc.","license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"title":"Crosswork Health Insights API","version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/health_insights_overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/hi/v1","description":"Generated server url"}],"securitySchemes":{"bearerAuth":{"description":"token","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"operationId":"GetEstimatedCDG","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseLoadCalculatorDevicesReq","properties":{"Kpi_tags_devices":{"description":"Kpi_tags_devices","items":{"description":"Description for pulseKpiTagsDevice","properties":{"Kpi_tags_list":{"description":"Kpi_tags_list","items":{"description":"Description for pulseKpiTagList","properties":{"CadenceInSeconds":{"description":"CadenceInSeconds","format":"uint64","type":"array"},"KpiId":{"description":"KpiId","type":"array"},"Kpi_tags":{"description":"Kpi_tags","items":{"description":"Description for pulseKpiTag","properties":{"Count":{"description":"Count","format":"uint64","type":"array"},"Tag":{"description":"Tag","type":"array"}},"title":"KpiTags contains the tags and their expected count","type":"object","$$ref":"#/components/schemas/pulseKpiTag"},"type":"array"}},"title":"KpiTagList contains kpi and corresponding tags","type":"object","$$ref":"#/components/schemas/pulseKpiTagList"},"type":"array"},"Number_of_devices":{"description":"Number_of_devices","format":"uint64","type":"array"}},"title":"KpiTagsDevices contains count of devices per Kpi tags list","type":"object","$$ref":"#/components/schemas/pulseKpiTagsDevice"},"type":"array"}},"title":"LoadCalculatorDevicesReq contains count of devices per Kpi and count of tags per KPI","type":"object","$$ref":"#/components/schemas/pulseLoadCalculatorDevicesReq"}}},"description":"GetEstimatedCDG is used by the load calculator. It accepts a count of devices and their corresponding KPI tags, per KPI and returns the total number of CDGs required to support the same.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseLoadCalculatorResp","example":{},"properties":{"Estimated_Devices_Per_CDG":{"description":"Estimated_Devices_Per_CDG","format":"uint64","type":"array"},"Estimated_Number_Of_CDGs":{"description":"Estimated_Number_Of_CDGs","format":"uint64","type":"array"},"Total_Devices":{"description":"Total_Devices","format":"uint64","type":"array"},"Total_Kpis":{"description":"Total_Kpis","format":"uint64","type":"array"},"Total_Tags":{"description":"Total_Tags","format":"uint64","type":"array"}},"title":"LoadCalculatorResp contains estimated number of CDGs or estimated devices per CDG","type":"object","$$ref":"#/components/schemas/pulseLoadCalculatorResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"}},"summary":"Calculate CDG requirements for devices and KPIs","tags":["Health Insights CDG load calculator"],"x-codegen-request-body-name":"body","__originalOperationId":"GetEstimatedCDG","security":[{"bearerAuth":[]}],"method":"post","path":"/kpi/loadcalculator/estimatecdgs"}}