From 86669ea8a94fb09c5b233d8b751ab16a582add3a Mon Sep 17 00:00:00 2001 From: lizi Date: Wed, 11 Oct 2017 17:38:40 +0800 Subject: [PATCH] Add consumed api details in doc. Change-Id: If05bd6d25aa34b23499d945f33aa63ce0dc6f56e Issue-ID: AAI-427 Signed-off-by: lizi --- docs/platform/consumedapis.rst | 67 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 5124ec4..2a8ce7c 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -5,3 +5,70 @@ Consumed APIs ------------- In the Amsterdam release, Holmes does not consume any APIs provided by other ONAP components. + +A&AI +^^^^ + +ESR stored external system data to A&AI. EMS/VNFM/Third-party SDNC operation API included in external system namespace. VIM operation API included in CloudInfrastructure namespace. + +#. VIM management API: + + ``PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}`` + + ``GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}`` + + ``GET /cloud-infrastructure/cloud-regions`` + + ``DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}`` + +#. VNFM management API: + + ``PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}`` + + ``GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}`` + + ``GET /external-system/esr-vnfm-list`` + + ``DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}`` + +#. EMS management API: + + ``PUT /external-system/esr-ems-list/esr-ems/{ems-id}`` + + ``GET /external-system/esr-ems-list/esr-ems/{ems-id}`` + + ``GET /external-system/esr-ems-list`` + + ``DELETE /external-system/esr-ems-list/esr-ems/{ems-id}`` + +#. Thirdparty SDNC management API: + + ``PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}`` + + ``GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}`` + + ``GET /external-system/esr-thirdparty-sdnc-list`` + + ``DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}`` + +More details could be found at `A&AI APIs `_. + +Multi-Cloud +^^^^^^^^^^^ + +ESR will call the API from Multi-Cloud to update the cloud-region infomation after put the VIM data to A&AI. + +#. Update VIM Info: + + ``POST /api/multicloud /v0/{cloud-owner}_{cloud-region}/registry`` + +More details could be found at `Multi-Cloud APIs `_. + +MSB +^^^ + +Both esr-server and esr-gui need to registered to MSB. + +Service Registration: ``/api/microservices/v1/services`` + +More details could be found at `MSB APIs `_. \ No newline at end of file -- 2.16.6