X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fplatform%2Fconsumedapis.rst;h=24dce36bb6ce1dd7885cf0a6fc77b485717e2ee4;hb=53506cec0c9e2366e1a7bc81a554eac278b0b254;hp=5124ec40218f17d6ca871549cc097e079c68f562;hpb=c6513385acc892dbaf1883df9f93b519e7c49207;p=aai%2Fesr-server.git diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 5124ec4..24dce36 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 information after put the VIM data to A&AI. + +#. Update VIM Info: + + ``POST /api/multicloud /v1/{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 `_.