Service Health Historical Data APIs

Version 7.1.0

v7.0.0 - 2024-08-24

Changed

POST /confighandlemonitorerror/get

Request:

Deleted content type : application/json

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property configHandleMonitorError (boolean)

    Global settings configuration to handle the Monitor Error.

  • Changed property errmsg (string)

    Error message

  • Changed property status (string)

    Response Status - Global settings configuration to handle the Monitor Error.

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

POST /confighandlemonitorerror/set

Request:

Changed content type : application/json

• Changed property configHandleMonitorError (boolean)

  Global settings configuration to handle the Monitor Error.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property configHandleMonitorError (boolean)

    Global settings configuration to handle the Monitor Error.

  • Changed property errmsg (string)

    Error message

  • Changed property status (string)

    Response Status - Global settings configuration to handle the Monitor Error.

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

POST /historicaldatacheck

Request:

Changed content type : application/json

• Added property graphOnly (boolean)

  When set to true will return graph minimal data for consumers like UI to render VPN graph

• Changed property serviceId (string)

  Service-id

• Changed property eosTimestamp (string)

  EOS timestamp

• Changed property numOfDays (integer)

  Duration - Number of days

• Changed property serviceType (string)

  Type of the service

• Changed property vpnNodeIds (array)

  Device Ids or Endpoints of the service

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property archiveDataExists (boolean)

    True if historical data exists for the given Service

Changed response : **default **

A default value response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

POST /dashboard/sla

Request:

Changed content type : application/json

• Changed property serviceType (string)

  Service type

Return Type:

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property errmsg (string)

    Error message

  • Changed property serviceType (string)

    Service Type

  • Changed property status (string)

    Response Status - SLA breaches count for SH Dashboard

  • Changed property serviceBreach (array)

    SLA sessions and breaches of the services

    Changed items (object): > Service Breach

    • Changed property serviceId (string)

      Service Id

    • Changed property serviceStatus (string)

      Status of the service

    • Changed property totalSessions (integer)

      Total probe sessions of the service

    • Changed property totalBreaches (integer)

      Total session breaches of the service

    • Changed property fwdDelayBreaches (integer)

      L3VPN Forward delay breaches count

    • Changed property fwdVarianceBreaches (integer)

      L3VPN Forward variance breaches count

    • Changed property fwdLossBreaches (integer)

      L2VPN/L3VPN Forward packets-lost breaches count

    • Changed property rvsDelayBreaches (integer)

      L3VPN Reverse delay breaches count

    • Changed property rvsVarianceBreaches (integer)

      L3VPN Reverse variance breaches count

    • Changed property rvsLossBreaches (integer)

      L2VPN/L3VPN Reverse packets-lost breaches count

    • Changed property thresholdValues (object)

      Threshold data

      • Changed property delayThreshold (string)

        Delay threshold

      • Changed property varianceThreshold (string)

        Variance threshold

      • Changed property lossThreshold (string)

        Packets-lost threshold

POST /historicaltimeline

Request:

Changed content type : application/json

• Added property graphOnly (boolean)

  When set to true will return graph minimal data for consumers like UI to render VPN graph

• Changed property serviceId (string)

  Service-id

• Changed property eosTimestamp (string)

  EOS timestamp

• Changed property numOfDays (integer)

  Duration - Number of days

• Changed property serviceType (string)

  Type of the service

• Changed property vpnNodeIds (array)

  Device Ids or Endpoints of the service

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error details in case the request failed.

  • Changed property status (string)

    Response - Timeline Events Status mapping

  • Changed property timeLineEvents (array)

    Timeline Events

    Changed items (object): > Summary of EOS data.

    • Added property deviceId (string)

      Device id

    • Added property nodeStatus (string)

      Service Health Statuses:

      • UNKNOWN: Default state displayed by CNC-ISTP, when monitoring is not enabled for a given service.
      • MONITORING_INITIATED: When a monitoring request is received for a service, Service Health initializes the service or subservice to this state.
      • MONITORING_FAILED: Indicates Service Health has encountered an internal error or failure.
      • MONITORING_PAUSED: Indicates that monitoring is currently paused, but historical data is still available for inspection through the timeline.
      • 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.
      • 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.
      • 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.

      Enum values:

      • UNKNOWN
      • MONITORING_INITIATED
      • MONITORING_FAILED
      • MONITORING_PAUSED
      • SERVICE_UP
      • SERVICE_DOWN
      • SERVICE_DEGRADED

    • Changed property eventTimestamp (string)

      The timestamp when the event of significance happened

    • Changed property serviceId (string)

      Top level service-id

    • Changed property symptoms (integer)

      The number of symptoms

    • Changed property serviceFilename (string)

      Archiver service filename with path

POST /dashboard/metrics

Request:

Deleted content type : application/json

Return Type:

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property errmsg (string)

    Error message

  • Changed property status (string)

    Response Status - Get Dashboard metrics.

  • Changed property servicesCount (array)

    Count of services

    Changed items (object): > Current count of services of a particular service type

    • Changed property serviceType (string)

      specify the type of service

    • Changed property totalCount (integer)

      current count of service

    • Changed property monitoredCount (integer)

      Monitored count

    • Changed property slaCount (integer)

      current count of SLA breaches

    • Changed property kpiCount (integer)

      current count of KPI breaches

    • Changed property healthState (object)

      Health State Count

      • Changed property initiated (integer)

        Initiated

      • Changed property down (integer)

        Down

      • Changed property degraded (integer)

        Degraded

      • Changed property good (integer)

        Good

      • Changed property unmonitored (integer)

        Unmonitored

    • Changed property monitorState (object)

      Monitor State

      • Changed property basic (object)

        Monitor State Count

        • Changed property down (integer)

          Down

        • Changed property degraded (integer)

          Degraded

        • Changed property good (integer)

          Good

        • Changed property totalCount (integer)

          Total count

POST /historicalmetrics

Request:

Changed content type : application/json

• Changed property serviceId (string)

  Service-id

• Changed property eventTimestamp (string)

  A timestamp indicating when an event of significance happened.

• Changed property serviceType (string)

  Type of the service

• Changed property vpnNodeIds (array)

  Device Ids on the service

Return Type:

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property eventTimestamp (string)

    The timestamp when the event of significance happened

  • Changed property serviceId (string)

    The tracking-id of the Service

  • Changed property error (string)

    Error details in case the request failed

  • Changed property metricList (object)

    Metric_instance_id and corresponding metric

POST /kpimetrics

Request:

Changed content type : application/json

• Changed property serviceId (string)

  Request KPI Metrics data for the Service-Id

• Changed property timeRange (integer)

  Duration - Number of hours/days

• Changed property serviceType (string)

  Type of the service

• Changed property probeSessionId (string)

  Probe session id

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property serviceId (string)

    Service-id

  • Changed property error (string)

    Error details in case the request failed

  • Changed property subserviceMetricList (object)

    Subservice-id and corresponding metric list

POST /historicalservice

Request:

Changed content type : application/json

• Added property graphOnly (boolean)

  When set to true will return graph minimal data for consumers like UI to render VPN graph

• Changed property serviceId (string)

  Service-id

• Changed property eosTimestamp (string)

  EOS timestamp

• Changed property numOfDays (integer)

  Duration - Number of days

• Changed property serviceType (string)

  Type of the service

• Changed property vpnNodeIds (array)

  Device Ids or Endpoints of the service

Return Type:

Changed response : **default **

An unexpected error response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error

  • Changed property code (integer)

    Code

  • Changed property message (string)

    Message

  • Changed property details (array)

    Details

    Changed items (object): > Protobuf any

    • Changed property typeUrl (string)

      Type URL

    • Changed property value (string)

      Value

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property serviceId (string)

    The ID of the service.

  • Changed property rootSubservices (array)

    List of IDs of the subservice nodes that are directly connected to the service node.

  • Changed property fragmentId (integer)

    Kafka message chunking fragment ID

  • Changed property moreFragments (boolean)

    Flag to indicate if more Kafka message chunking fragments are available

  • Changed property healthReport (object)

    Service Health report

    • Changed property liveMetricFeeds (object)

      Live Metric Feeds

    • Changed property subServiceHealthReports (object)

      subService Health Reports

  • Changed property assuranceGraph (object)

    Service Graph

    • Changed property softRootSubserviceNodes (array)

      List of Subservice-ids that have a soft relationship with the service node.

    • Changed property subserviceDependencies (array)

      Subservice dependencies

      Changed items (object): > Subservice SG node

      • Changed property id (string)

        subservice-id UUID

      • Changed property subServiceClass (string)

        SubserviceClass Name

      • Changed property namespace (string)

        Namespace

      • Changed property description (string)

        Description

      • Changed property staticId (string)

        The combination of subServiceClass, namespace and config

      • Changed property dynamicSS (boolean)

        Flag indicating that the given subservice is dynamic.

      • Changed property subDeps (array)

        Hard Dependencies: List of subservice-ids which are of string type.

      • Changed property softSubDeps (array)

        Soft Dependencies: List of subservice-ids which are of string type.

      • Changed property dynamicSubDeps (array)

        List of hard and soft dynamic subservice dependencies. These lists can change dynamically independent of the rest of the Service Graph.

      • Changed property dynamicSoftSubDeps (array)

        Dynamic soft sub-dependencies

      • Changed property config (object)

        The Subservice Configuration.

        • Changed property args (array)

          List of arguments passed to this subservice.

          Changed items (object): > Subservice Config Arg

          • Changed property values (array)

            Given argument could be a list of values like [Tor-A, Tor-B] for given key-name 'Devices'

          • Changed property param (object)

            HP Element Parameter

            • Changed property description (string)

              Description