diff options
author | guochuyicmri <guochuyi@chinamobile.com> | 2019-06-11 15:35:08 +0800 |
---|---|---|
committer | guochuyicmri <guochuyi@chinamobile.com> | 2019-06-11 15:35:09 +0800 |
commit | b74f1453b2c309b7395b909762a3d3543dab6406 (patch) | |
tree | 018a756281c78059f4e6813989ba2afcc9c1b728 /docs/platform/consumed_api.rst | |
parent | 88e152431069d134edeb8ad80e1cd3944708a6f5 (diff) |
add usecase-ui user guide
Change-Id: I97155072f9cf212ce6a2155bd07a6c57546222e5
Issue-ID: USECASEUI-194
Signed-off-by: guochuyicmri <guochuyi@chinamobile.com>
Diffstat (limited to 'docs/platform/consumed_api.rst')
-rw-r--r-- | docs/platform/consumed_api.rst | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/platform/consumed_api.rst b/docs/platform/consumed_api.rst new file mode 100644 index 00000000..84523d9f --- /dev/null +++ b/docs/platform/consumed_api.rst @@ -0,0 +1,72 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Usecase-UI Consumed APIs +======================== + +References to APIs offered by other components + +VFC APIs +-------- +#. Distribute Network Service package: + ``POST /api/catalog/v1/nspackages`` + +#. Distribute VF resource: + ``POST /api/catalog/v1/vnfpackages`` + +#. Query operation progress for distributing network service/vf resource: + ``GET /api/nslcm/v1/jobs/{jobId}`` + +#. Delete Network Service package: + ``DELETE /api/catalog/v1/nspackages/{csarId}`` + +#. Delete VF resource: + ``DELETE /api/catalog/v1/vnfpackages/{csarId}`` + +SDC APIs +-------- +#. Query all distributed End to End Service: + ``GET /sdc/v1/catalog/services`` + +#. Query specified service: + ``GET /sdc/v1/catalog/services/{uuid}/metadata`` + +#. Query VF resource: + ``GET /sdc/v1/catalog/resources`` + +#. Download csar file: + ``GET /sdc/v1/catalog/services/{uuid}/toscaModel`` + +A&AI APIs +--------- +#. Query all customers: + ``/aai/v11/business/customers`` + +#. Query all service types for the specified customer: + ``/aai/v11/business/customers/customer/{global-customer-id}/service-subscriptions`` + +#. Query all service instances: + ``/aai/v11/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances`` + +#. Query all cloud regions: + ``/aai/v11/cloud-infrastructure/cloud-regions`` + +#. Query all sdnc controllers: + ``/aai/v11/external-system/esr-thirdparty-sdnc-list`` + +SO APIs +------- +#. Instantiate service instance: + ``POST /ecomp/mso/infra/e2eServiceInstances/v3`` + +#. Query operation progress for service instantiation/termination: + ``GET /ecomp/mso/infra/e2eServiceInstances/v3/{serviceId}/operations/{operationId}`` + +#. Terminate service instance: + ``DELETE /ecomp/mso/infra/e2eServiceInstances/v3/{serviceId}`` + +MSB APIs +-------- +#. Service Registration: + ``/api/microservices/v1/services`` |