{"type":"api","title":"Displays Vitals for given Data Gateway","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/a5d714ab-2dd2-35c9-ad40-e250963b36ec","info":{"title":"Crosswork Data Gateway Health API","description":"APIs to get Data Gateway Health.","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/cdg_health_api_overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manager/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"description":"Displays the vitals info for given Data Gateway.Replaces earlier GET /crosswork/dg-manager/device/vitals/ API","summary":"Displays Vitals for given Data Gateway","tags":["Misc"],"operationId":"GetHealthOfDG","deprecated":false,"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Body","in":"body","required":true,"description":"Request payload to get health of DG","schema":{"title":"GetHealthOfDG","example":{"queryParams":[{"field":"DGID","value":{"valueStr":"6ddad364-77d1-4f3a-b3b8-2371789436a3"}}]},"type":"object","properties":{"queryParams":{"type":"array","items":{"title":"QueryParam","example":{"field":"DGID","value":{"valueStr":"6ddad364-77d1-4f3a-b3b8-2371789436a3"}},"type":"object","properties":{"field":{"type":"string"},"value":{"title":"Value","example":{"valueStr":"6ddad364-77d1-4f3a-b3b8-2371789436a3"},"type":"object","properties":{"valueStr":{"type":"string"}},"required":["valueStr"],"$$ref":"#/definitions/Value"}},"required":["field","value"],"$$ref":"#/definitions/QueryParam"}}},"required":["queryParams"],"$$ref":"#/definitions/GetHealthOfDG"}}],"responses":{"200":{"description":"OK","schema":{"title":"HealthOfDGResponse","example":{"components":[{"cpuUsage":0.06,"memory":{"baseUnit":"Megabytes","used":364.591266,"free":6077.884254},"memPercent":5.66,"name":"gnmi-collector","blockIOStats":{"baseUnit":"Megabytes","read":0,"write":227},"networkStats":{"baseUnit":"Megabytes","received":18.8,"sent":13.1},"status":"RUNNING","error":"","tag":"4.0.0","thresholdCpu":"NORMAL","thresholdMemory":"NORMAL","gcHeapInfo":{"totalHeapSize":151552,"usedHeapSize":91758,"baseUnit":"Kilobytes","timeStamp":"1648670199"},"netIoRate":{"inputPerSecond":44,"outputPerSecond":57,"baseUnit":"Bytes","timeStamp":"1648670250"},"containerImage":"7.1.0_develop_1399_2025-03-31_05-01-02"}]},"type":"object","properties":{"components":{"type":"array","items":{"title":"QueryParam","example":{"field":"DGID","value":{"valueStr":"6ddad364-77d1-4f3a-b3b8-2371789436a3"}},"type":"object","properties":{"field":{"type":"string"},"value":{"title":"Value","example":{"valueStr":"6ddad364-77d1-4f3a-b3b8-2371789436a3"},"type":"object","properties":{"valueStr":{"type":"string"}},"required":["valueStr"],"$$ref":"#/definitions/Value"}},"required":["field","value"],"$$ref":"#/definitions/QueryParam"}}},"$$ref":"#/definitions/HealthOfDGResponse"},"examples":{"application/json":{"containers":[{"serviceName":"dg-cli-collector-service","containerName":"cli-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0},{"serviceName":"dg-gnmi-collector-service","containerName":"gnmi-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0},{"serviceName":"dg-mdt-collector-service","containerName":"mdt-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0},{"serviceName":"dg-netconf-collector-service","containerName":"netconf-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0},{"serviceName":"dg-snmp-collector-service","containerName":"snmp-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0},{"serviceName":"dg-syslog-collector-service","containerName":"syslog-collector","memoryLimit":"6g","cpuSet":"2-9","cpuQuota":0,"cpuShares":0}]}},"headers":{}},"500":{"description":"Internal Server Error"}},"__originalOperationId":"GetHealthOfDG","security":[{"bearerAuth":[]}],"method":"post","path":"/vitals/query"}}