summaryrefslogtreecommitdiffstats
path: root/docs/platform
diff options
context:
space:
mode:
authorhekeguang <hekeguang@chinamobile.com>2020-04-17 09:20:34 +0800
committerHe Keguang <hekeguang@chinamobile.com>2020-04-17 03:08:17 +0000
commitda22de958013506c0a5b2ff6d055425a8c1fae3c (patch)
tree18cbbad21a0215519a9e392ecf38e427efbace7c /docs/platform
parentc616b584fcc735854c97eee715cd1e31e7cfc9a7 (diff)
Supplement the consumed API part of UUI user guide
Issue-ID: USECASEUI-428 Change-Id: Icb33b0f8d6b43d8dc05f2d03250adfb2de4c3f91 Signed-off-by: hekeguang <hekeguang@chinamobile.com>
Diffstat (limited to 'docs/platform')
-rw-r--r--docs/platform/consumed_api.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/platform/consumed_api.rst b/docs/platform/consumed_api.rst
index 84523d9f..030ea768 100644
--- a/docs/platform/consumed_api.rst
+++ b/docs/platform/consumed_api.rst
@@ -55,6 +55,30 @@ A&AI APIs
#. Query all sdnc controllers:
``/aai/v11/external-system/esr-thirdparty-sdnc-list``
+#. Query 5G slicing service instances:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-role=e2eslice-service``
+
+#. Query 5G slicing NSI instances:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-role=nsi``
+
+#. Query 5G slicing NSSI instances:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-role=nssi``
+
+#. Query 5G slicing service profiles:
+ ``GET /api/aai-business/v19/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles``
+
+#. Query allotted resources of 5G slicing service:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources``
+
+#. Query information associated with 5G slicing service/NSI/NSSI/:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}``
+
+#. Query NST associated with 5G slicing service:
+ ``GET /api/aai-sdc/v13/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}``
+
+#. Query 5G slicing order:
+ ``GET /api/aai-business/v13/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-role=communication-service``
+
SO APIs
-------
#. Instantiate service instance:
@@ -66,6 +90,30 @@ SO APIs
#. Terminate service instance:
``DELETE /ecomp/mso/infra/e2eServiceInstances/v3/{serviceId}``
+#. Query operation progress:
+ ``GET /api/so-serviceInstances/v3/{serviceId}/operations/{operationId}``
+
+#. Activate 5G slicing service:
+ ``POST /api/so-serviceInstances/v3/{serviceInstanceId}/activate``
+
+#. Deactivate 5G slicing service:
+ ``POST /api/so-serviceInstances/v3/{serviceInstanceId}/deactivate``
+
+#. Terminate 5G slicing service:
+ ``DELETE /api/so-serviceInstances/v3/{serviceInstanceId}``
+
+#. Query 5G slicing task:
+ ``GET /api/so-orchestrationTasks/v4``
+
+#. Update 5G slicing task:
+ ``PUT /api/so-orchestrationTasks/v4/{taskId}``
+
+#. Commit 5G slicing task:
+ ``POST /api/so-orchestrationTasks/v4/{taskId}/commit``
+
+#. Submit 5G slicing order:
+ ``POST /api/so-serviceInstances/v3``
+
MSB APIs
--------
#. Service Registration: