...
High Level Sequence Diagram of Holmes
API Incoming Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Data Movement as a Platform APIs | DMaaP message sub/pub related APIs which will be used by Holmes to collect the data from and publish data to DMaaP topics. | |||||||||
| Resource Query | Query different resource information from A&AI. All A&AI operations are implemented in the form of RESTful APIs. I'm using "Resource Query" as a general name for the APIs in case there will be too many APIs listed here. | AAI API | ||||||||
| Event Sending API provided by Policy | Send an event (or other legal data) to the Policy engine. | CLAMP DCAE APIs | APIs used to interact with CLAMP (rule deployment, transferring execution results, etc.)for service registration and discovery. | <<DocRef:CLAMP DCAE API Documents>> | DCAE APIs | APIs used for service registration and discovery. | ||||
Service Registration/Un-registration Service Discovery | The APIs used to register/un-register a micro-service to/from MSB . The APIs used to discover another micro-service via MSB. | Microservice Bus API Documentation<<DocRef:DCAE API Documents>> |
API Outgoing Dependencies
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |||||
|---|---|---|---|---|---|---|---|---|---|
| Rule Creating | This API is intended for creating a rule in the database. |
| August, 24th, 2017 | Rule Management - Beijing | |||||
| Rule Modifying | This API is intended for modifying a rule in the database. |
| August, 24th, 2017 | Rule Management - Beijing | |||||
| Rule Deleting | This API is intended for deleting a rule from the database. |
| August, 24th, 2017 | Rule Management - Beijing | |||||
| Rule Query | This API is intended for querying rules from the database. |
| August, 24th, 2017 | Rule Management - Beijing | |||||
| Rule Deploying | This API is intended for deploying the rule(s) into the rule engine. |
| August, 24th, 2017 | Engine Management - Beijing | |||||
| Rule Deleting from the Rule Engine | This API is intended for removing the rule(s) from the rule engine. |
| August, 24th, 2017 | Engine Management - Beijing | |||||
| Rule Verifying | This API is intended for verifying a rule. |
| August, 24th, 2017 | Engine Management - Beijing | |||||
| Health -checkCheck | This API is used by other components to check whether Holmes is working. | TBD | August, 24th, 2017 | TBD | Statistic Data Query | This API is used by the client projects to query statistics data provided by Holmes. | TBD
| August, 24th, 2017 | TBDHealth Check - Beijing |
Third Party Products Dependencies
...