Service Health Assurance Graph APIs

Version 7.1.0

v7.0.0 - 2024-08-24

Changed

POST /impactedServices

Get the list of impacted Services for a given subservice_id. The valid content type in the request can be application/json, OR application/json;charset=UTF8.

Request:

Changed 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 services (array)

    There can be multiple services referring to a given subservice.

    Changed items (object): > Providing the service details like service type and name along with ID.

    • Changed property serviceId (string)

      Service id

    • Changed property serviceType (string)

      Service type

    • Changed property serviceName (string)

      Service name

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 of GatewayruntimeError

  • Changed property code (integer)

    Code of GatewayruntimeError

  • Changed property message (string)

    Message of GatewayruntimeError

  • Changed property details (array)

    Details of GatewayruntimeError

    Changed items (object): > ProtobufAny

    • Changed property typeUrl (string)

      typeUrl of protobufAny

    • Changed property value (string)

      Value of protobufAny

POST /matchingSubservices

Get matching subservices for a given service-id. The valid content type in the request can be application/json, OR application/json;charset=UTF8.

Request:

Changed content type : application/json

• Changed property tags (array)

  To be used when Type is TAGGED_SUBSERVICES

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 of GatewayruntimeError

  • Changed property code (integer)

    Code of GatewayruntimeError

  • Changed property message (string)

    Message of GatewayruntimeError

  • Changed property details (array)

    Details of GatewayruntimeError

    Changed items (object): > ProtobufAny

    • Changed property typeUrl (string)

      typeUrl of protobufAny

    • Changed property value (string)

      Value of protobufAny

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 detail on hitting error

  • Changed property subservices (array)

    List of policy subservices

    Changed items (object): > Subservice node

    • Changed property id (string)

      subservice id - uuid

    • Changed property subservice_class (string)

      Subservice class

    • Changed property namespace (string)

      Namespace

    • Changed property static_id (string)

      Static id

    • Changed property create_timestamp (string)

      Create timestamp

    • Changed property update_timestamp (string)

      Update timestamp

    • Changed property config (object)

      Subservice Config

      • 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 items (string): > String

        • Changed property parameter (object)

          HPElem Param

          • Changed property description (string)

            Description of HPElemParam

    • Changed property oper (object)

      Subservice Oper State

      • Changed property healthScore (integer)

        Health score

      • Changed property healthTs (string)

        The last time the subservice health got updated

      • Changed property liveMetricFeeds (object)

        Live metric feeds

      • Changed property componentErrors (object)

        Component errors

      • Changed property subGraph (object)

        Service Graph

        • 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)

            Subservice namespace

          • Changed property description (string)

            SubserviceClass Description

          • Changed property staticId (string)

            Combination of subservice_class, namespace and config

          • Changed property dynamicSS (boolean)

            Flag indicating if the given subservice is dynamic

          • Changed property subDeps (array)

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

            Changed items (string): > String

          • Changed property softSubDeps (array)

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

            Changed items (string): > String

          • 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 items (string): > String

          • Changed property dynamicSoftSubDeps (array)

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

            Changed items (string): > String

      • Changed property rootExpressionStatus (object)

        Output Simple Value

        • Changed property str (string)

          String value of outputSimpleValue

        • Changed property fl (number)

          Float value of outputSimpleValue

        • Changed property d (number)

          Double value of outputSimpleValue

        • Changed property int (string)

          Int64 value of outputSimpleValue

        • Changed property u (string)

          Uint64 value of outputSimpleValue

        • Changed property b (boolean)

          Boolean value of outputSimpleValue

        • Changed property nodeID (string)

          Node-id of outputSimpleValue

        • Changed property subserviceName (string)

          SubserviceName of outputSimpleValue

        • Changed property send (boolean)

          Send of outputSimpleValue

        • Changed property errors (array)

          Errors of outputSimpleValue

        • Changed property strList (object)

          List of Output SimpleValue String List

          • Changed property list (array)

            List of OutputSimpleValueStringList

            Changed items (string): > string

        • Changed property flList (object)

          Output SimpleValue Float List

          • Changed property list (array)

            List of OutputSimpleValueFloatList

            Changed items (number): > Float

        • Changed property intList (object)

          Output SimpleValue Int List

          • Changed property list (array)

            List of OutputSimpleValueIntList

            Changed items (string): > Int64

        • Changed property uintList (object)

          List of Output SimpleValue Uint List

          • Changed property list (array)

            List of OutputSimpleValueUintList

            Changed items (string): > unit64

        • Changed property bList (object)

          Output SimpleValue Boolean List

          • Changed property list (array)

            List of OutputSimpleValueBoolList

            Changed items (boolean): > Boolean

        • Changed property status (object)

          Status which represents the health and symptoms.

          • Changed property symptoms (array)

            Symptoms of OutputSimpleValueStatus

        • Changed property alert (object)

          Simple Value Alert

          • Changed property level (string)

            Level of SimpleValueAlert

          • Changed property message (string)

            Message of SimpleValueAlert

        • Changed property dList (object)

          Output SimpleValue Double List

          • Changed property list (array)

            List of OutputSimpleValueDoubleList

            Changed items (number): > Double

        • Changed property symptoms (array)

          Symptoms of outputSimpleValue

          Changed items (object): > Exptracker Output Symptom

          • Changed property label (string)

            Label of ExptrackerOutputSymptom

          • Changed property start (string)

            Start of ExptrackerOutputSymptom

          • Changed property end (string)

            End of ExptrackerOutputSymptom

          • Changed property symptoms (array)

            Symptoms of ExptrackerOutputSymptom

          • Changed property priority (integer)

            Priority of ExptrackerOutputSymptom

          • Changed property nodeID (string)

            nodeId of ExptrackerOutputSymptom

          • Changed property cdgID (string)

            cdgId of ExptrackerOutputSymptom

        • Changed property level (string)

          Exptracker Health

        • Changed property calculations (object)

          Output Calculations

          • Changed property expLabel (string)

            Exp Label of OutputCalculations

          • Changed property evalExpressionString (string)

            Eval Expression String of OutputCalculations

          • Changed property observedValue (string)

            Observed value of OutputCalculations

          • Changed property subExps (array)

            SubExps of OutputCalculations

          • Changed property profileConstants (object)

            Profile Constants of OutputCalculations

          • Changed property symptomMetrics (array)

            Symptom metrics of OutputCalculations

            Changed items (object): > Output Calculations Symptom Metric

            • Changed property metricInstance (string)

              MetricInstance of OutputCalculationsSymptomMetric

            • Changed property value (string)

              Value of OutputCalculationsSymptomMetric

            • Changed property displayLabel (string)

              Display label of OutputCalculationsSymptomMetric

      • Changed property ruleTriggerConditions (object)

        SubserviceOperState Rule Trigger Conditions.

        • Changed property paramMapWithTimestamp (object)

          Map with key as parameter name and value as timestamp.

        • Changed property activate (object)

          Output Conditionals

          • Changed property treeID (string)

            TreeID of OutputConditionals

          • Changed property labels (object)

            Labels of OutputConditionals

          • Changed property nodeID (string)

            Node id of OutputConditionals

          • Changed property send (boolean)

            Boolean value of OutputConditionals

          • Changed property treeType (string)

            Output Tree Type

        • Changed property ruleTriggerParamMap (object)

          Map to store the received conditionals parameters with their values.

POST /serviceDetails

Get the service details based on service_id and degraded_paths_only flag. The valid content type in the request can be application/json, OR application/json;charset=UTF8.

Request:

Changed content type : application/json

• Added property graph_only (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 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 of GatewayruntimeError

  • Changed property code (integer)

    Code of GatewayruntimeError

  • Changed property message (string)

    Message of GatewayruntimeError

  • Changed property details (array)

    Details of GatewayruntimeError

    Changed items (object): > ProtobufAny

    • Changed property typeUrl (string)

      typeUrl of protobufAny

    • Changed property value (string)

      Value of protobufAny

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 rootSubservices (array)

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

  • Changed property fragment_id (integer)

    Kafka message chunking fragment ID

  • Changed property more_fragments (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 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)

        Subservice namespace

      • Changed property description (string)

        SubserviceClass Description

      • Changed property staticId (string)

        Combination of subservice_class, namespace and config

      • Changed property dynamicSS (boolean)

        Flag indicating if the given subservice is dynamic

      • Changed property subDeps (array)

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

        Changed items (string): > String

      • Changed property softSubDeps (array)

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

        Changed items (string): > String

      • 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 items (string): > String

      • Changed property dynamicSoftSubDeps (array)

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

        Changed items (string): > String

      • Changed property config (object)

        Subservice Config

        • 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 items (string): > String

          • Changed property parameter (object)

            HPElem Param

            • Changed property description (string)

              Description of HPElemParam