X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fplatform%2Fconsumedapis.rst;h=9c0a0ffd13ac39819d35ff5e806aa4a395535995;hb=e55711e1485de2f8cbddff135eea239c06bc8104;hp=d7ce36293b2a0b502dab6fb63a3749530c588134;hpb=f5a25bfcba09ba5443e3c3bc130ded015b0e2b3a;p=holmes%2Frule-management.git diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index d7ce362..9c0a0ff 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -4,7 +4,7 @@ Consumed APIs ------------- -In the Amsterdam release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. +In the Honolulu release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB. DCAE ^^^^ @@ -17,28 +17,34 @@ A&AI In order to get the correlation between different alarms with the help of the topological information provided by A&AI. Holmes needs to call the A&AI APIs. Generally, we have to query the information of VNFs, VMs and the corresponding relation between resources from different layers. The following APIs are invoked by Holmes. #. Query a VNF by name: + ``/aai/v11/network/generic-vnfs/generic-vnf?vnf-name={vnf-name}`` #. Query a VNF by ID: + ``/aai/v11/network/generic-vnfs/generic-vnf?vnf-id={vnf-id}`` #. Query a VM by name: + ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-name:EQUALS:{vserver-name}`` #. Query a VM by ID: - ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}`` + + ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}`` More details could be found at `A&AI APIs `_. - + DMaaP ^^^^^ Holmes fetches VES data from DMaaP and publishes the control loop event back to DMaaP. The related APIs are: #. Subscribing: - ``events/{topic}/{consumergroup}/{consumerid}`` + + ``/events/{topic}/{consumergroup}/{consumerid}`` #. Publishing: + ``/events/{topic}`` More details could be found at `DMaaP APIs `_.