{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/960a628c-2f33-3367-a4ec-faca586888c5","info":{"title":"Service Health Historical Data APIs","description":"APIs for requesting historical data recorded by the Crosswork Service Health application.","termsOfService":"terms-of-service","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"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/sh_application_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/aa/aaapp/v1/"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"type":"object","properties":{"eventTimestamp":{"description":"The timestamp when the event of significance happened","type":"string","format":"int64"},"serviceId":{"description":"Top level service-id","type":"string"},"serviceStatus":{"type":"string","description":"Service Health Statuses: \n - UNKNOWN: Default state displayed by CNC-ISTP, when monitoring is not enabled for a given service.\n - MONITORING_INITIATED: When a monitoring request is received for a service, Service Health initializes the service or subservice to this state.\n - MONITORING_FAILED: Indicates Service Health has encountered an internal error or failure.\n - MONITORING_PAUSED: Indicates that monitoring is currently paused, but historical data is still available for inspection through the timeline.\n - SERVICE_UP: At the service level, this state indicates that all the individual subservices of the monitored service are in good health and operating without any issues to report.\n - SERVICE_DOWN: All the different subservices of the Service that are being monitored are reporting issues. Corresponding symptoms should provide more details about the issues being encountered.\n - SERVICE_DEGRADED: At the Service level, this state indicates that some of the subservices of the Service that is being monitored are reporting issues. Corresponding symptoms should provide more details about the issues being encountered.","default":"UNKNOWN","enum":["UNKNOWN","MONITORING_INITIATED","MONITORING_FAILED","MONITORING_PAUSED","SERVICE_UP","SERVICE_DOWN","SERVICE_DEGRADED"],"$$ref":"#/components/schemas/HealthStatus"},"monitoringStatus":{"type":"string","description":"Monitoring statuses: \n - MONITORING_UNKNOWN: Default status, set when the monitoring status is unknown.\n - MONITORING_SUCCESS: Success state when there are no errors in monitoring.\n - ENCOUNTERED_ERRORS: State reflects the monitoring errors.","default":"MONITORING_UNKNOWN","enum":["MONITORING_UNKNOWN","MONITORING_SUCCESS","ENCOUNTERED_ERRORS"],"$$ref":"#/components/schemas/MonitoringStatus"},"symptoms":{"description":"The number of symptoms","type":"integer","format":"int32"},"serviceFilename":{"description":"Archiver service filename with path","type":"string"},"deviceId":{"description":"Device id","type":"string"},"nodeStatus":{"type":"string","description":"Service Health Statuses: \n - UNKNOWN: Default state displayed by CNC-ISTP, when monitoring is not enabled for a given service.\n - MONITORING_INITIATED: When a monitoring request is received for a service, Service Health initializes the service or subservice to this state.\n - MONITORING_FAILED: Indicates Service Health has encountered an internal error or failure.\n - MONITORING_PAUSED: Indicates that monitoring is currently paused, but historical data is still available for inspection through the timeline.\n - SERVICE_UP: At the service level, this state indicates that all the individual subservices of the monitored service are in good health and operating without any issues to report.\n - SERVICE_DOWN: All the different subservices of the Service that are being monitored are reporting issues. Corresponding symptoms should provide more details about the issues being encountered.\n - SERVICE_DEGRADED: At the Service level, this state indicates that some of the subservices of the Service that is being monitored are reporting issues. Corresponding symptoms should provide more details about the issues being encountered.","default":"UNKNOWN","enum":["UNKNOWN","MONITORING_INITIATED","MONITORING_FAILED","MONITORING_PAUSED","SERVICE_UP","SERVICE_DOWN","SERVICE_DEGRADED"],"$$ref":"#/components/schemas/HealthStatus"}},"description":"Summary of EOS data.","$$ref":"#/components/schemas/TimeLineEventsResponseEventOfSignificanceSummary","title":"TimeLineEventsResponseEventOfSignificanceSummary"}}