.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 Huawei Technologies Co., Ltd.
serviceInstances API
====================
This API allows to generate some requests to manage:
- serviceInstances (create, delete)
- volumeGroups attached to a vnf instance (create, delete)
- vfModules attached to a vnf instance (create, delete)
- vnfs attached to a service instance (create, delete)
- orchestrationRequests (get)
- CNF healthCheck
links:
- :ref:`create_service_instance`
- :ref:`delete_service_instance`
- :ref:`create_volume_group`
- :ref:`delete_volume_group`
- :ref:`create_vf_module`
- :ref:`delete_vf_module`
- :ref:`create_vnf`
- :ref:`delete_vnf`
- :ref:`create_cnf`
- :ref:`delete_cnf`
- :ref:`get_orchestration_request_by_id`
- :ref:`get_orchestration_request_all`
- :ref:`healthCheck`
.. _create_service_instance:
Create service instance
+++++++++++++++++++++++
+--------------------+--------------------------------------------------------+
|Interface Definition|Description |
+====================+========================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances |
+--------------------+--------------------------------------------------------+
|Operation Type |POST |
+--------------------+--------------------------------------------------------+
|Content-Type |application/json |
+--------------------+--------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|project |project Object |Content of project object. |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity |owningEntity Object |Content of owningEntity object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid |String |The Model Customization UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid |String |The Model UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid |String |The Model Invariant UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
SubscriberInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|GlobalSubscriberId |String |Global customer Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber |String |billingAccountNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl |String |callbackUrl of the request |
+-------------------------+------------------+-------------------------------------------------+
|correlator |String |correlator of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber |String |orderNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion |String |orderVersion of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|SubscriptionServiceType |String |The service type of the Subscription |
+-------------------------+------------------+-------------------------------------------------+
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
|aLaCarte |Boolean | aLaCarte |
+-------------------------+------------------+-------------------------------------------------+
|autoBuildVfModules |Boolean |autoBuildVfModules |
+-------------------------+------------------+-------------------------------------------------+
|cascadeDelete |Boolean |cascadeDelete |
+-------------------------+------------------+-------------------------------------------------+
|usePreload |Boolean |usePreload |
+-------------------------+------------------+-------------------------------------------------+
|rebuildVolumeGroups |Boolean |rebuildVolumeGroups |
+-------------------------+------------------+-------------------------------------------------+
|payload |String |payload |
+-------------------------+------------------+-------------------------------------------------+
|controllerType |String |controllerType |
+-------------------------+------------------+-------------------------------------------------+
UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|name |String |Tag name of attribute |
+-------------------------+------------------+-------------------------------------------------+
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
|aicNodeClli |String |aicNodeClli property |
+-------------------------+------------------+-------------------------------------------------+
Project Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|projectName |String |Name of the project |
+-------------------------+------------------+-------------------------------------------------+
OwningEntity Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|owningEntityId |String |owningEntityId of the owingEntity |
+-------------------------+------------------+-------------------------------------------------+
|owningEntityName |String |owningEntityName of the owingEntity |
+-------------------------+------------------+-------------------------------------------------+
Platform Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|platformName |String |Platform Name |
+-------------------------+------------------+-------------------------------------------------+
LineOfBusiness Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lineOfBusinessName |String |Line Of Business Name |
+-------------------------+------------------+-------------------------------------------------+
.. _delete_service_instance:
Delete service instance
+++++++++++++++++++++++
+--------------------+--------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId} |
+--------------------+--------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+--------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
.. _create_volume_group:
Create Volume Group
+++++++++++++++++++
+--------------------+------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+==================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
+--------------------+------------------------------------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+------------------------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|project |project Object |Content of project object. |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity |owningEntity Object |Content of owningEntity object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid |String |The Model Customization UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid |String |The Model UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid |String |The Model Invariant UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
|aicNodeClli |String |aicNodeClli property |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber |String |billingAccountNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl |String |callbackUrl of the request |
+-------------------------+------------------+-------------------------------------------------+
|correlator |String |correlator of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber |String |orderNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion |String |orderVersion of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|instanceId |String |instanceId |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
.. _delete_volume_group:
Delete Volume Group
+++++++++++++++++++
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
.. _create_vf_module:
Create VF Module
++++++++++++++++
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+===============================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+---------------------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|relatedInstanceList |List |Content of relatedInstanceList. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|InstanceName |String |The instance Name |
+-------------------------+------------------+-------------------------------------------------+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|SuppressRollback |Boolean |SuppressRollback |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|instanceId |String |instanceId |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |Name of the instance |
+-------------------------+------------------+-------------------------------------------------+
.. _delete_vf_module:
Delete VF Module
++++++++++++++++
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
.. _create_vnf:
Create VNF
++++++++++
+--------------------+-------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs |
+--------------------+-------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+-------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|project |project Object |Content of project object. |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity |owningEntity Object |Content of owningEntity object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid |String |The Model Customization UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid |String |The Model UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid |String |The Model Invariant UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber |String |billingAccountNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl |String |callbackUrl of the request |
+-------------------------+------------------+-------------------------------------------------+
|correlator |String |correlator of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber |String |orderNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion |String |orderVersion of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|instanceId |String |instanceId |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|name |String |Tag name of attribute |
+-------------------------+------------------+-------------------------------------------------+
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
.. _delete_vnf:
Delete VNF
++++++++++
+--------------------+-----------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId} |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-----------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|name |String |Tag name of attribute |
+-------------------------+------------------+-------------------------------------------------+
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
.. _create_cnf:
Create CNF
++++++++++
+--------------------+-------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/cnfs |
+--------------------+-------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+-------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|modelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|modelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|modelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationName |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
|cloudOwner |String |Name of the cloud owner |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|instanceId |String |instanceId |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|userParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|name |String |Tag name of attribute |
+-------------------------+------------------+-------------------------------------------------+
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
.. _delete_cnf:
Delete CNF
++++++++++
+--------------------+-----------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/cnfs/{cnfInstanceId} |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-----------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|modelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|modelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|modelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationName |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationId |String |The Model Customization Id. |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
|cloudOwner |String |Name of the cloud owner |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestId |String |request Id |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|name |String |Tag name of attribute |
+-------------------------+------------------+-------------------------------------------------+
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
.. _get_orchestration_request_by_id:
GET Orchestration Request
+++++++++++++++++++++++++
+--------------------+-------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================+
|URI |/onap/so/infra/orchestrationRequests/v7/{request-id} |
+--------------------+-------------------------------------------------------------------------------------+
|Operation Type |GET |
+--------------------+-------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|request |M |1 |request Object |Content of request object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
Request Object
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+===================+=========+===========+==========================+===========================================+
|requestId |M |1 |String |Request Id |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|startTime |M |1 |request Object |Start time. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestScope |M |1 |request Object |Scope of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestType |M |1 |request Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails |M |1 |requestDetails Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestStatus |M |1 |requestStatus Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|project |project Object |Content of project object. |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity |owningEntity Object |Content of owningEntity object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid |String |The Model Customization UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid |String |The Model UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid |String |The Model Invariant UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
SubscriberInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|GlobalSubscriberId |String |Global customer Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber |String |billingAccountNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl |String |callbackUrl of the request |
+-------------------------+------------------+-------------------------------------------------+
|correlator |String |correlator of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber |String |orderNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion |String |orderVersion of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|SubscriptionServiceType |String |The service type of the Subscription |
+-------------------------+------------------+-------------------------------------------------+
RequestStatus Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|finishTime |String |Time |
+-------------------------+------------------+-------------------------------------------------+
|requestState |String |state of the request |
+-------------------------+------------------+-------------------------------------------------+
|statusMessage |String |statusMessage |
+-------------------------+------------------+-------------------------------------------------+
|percentProgress |String |percentage of progress |
+-------------------------+------------------+-------------------------------------------------+
.. _get_orchestration_request_all:
GET Orchestration Requests
++++++++++++++++++++++++++
+--------------------+--------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================+
|URI |/onap/so/infra/orchestrationRequests/v7 |
+--------------------+--------------------------------------------------------------+
|Operation Type |GET |
+--------------------+--------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Query Parameters:
+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|Attribute |Required |Cardinality|Content|Description |
+===================+=========+===========+=======+=====================================================================================================+
|filter |Y |1 |String | Orchestration filter (scheme KeyTypes:Option:Value) |
| | | | | |
| | | | | KeyTypes: |
| | | | | serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName, |
| | | | | vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName, |
| | | | | networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName, |
| | | | | lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
| | | | | |
| | | | | Option: |
| | | | | EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF] |
| | | | | for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES |
| | | | | [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030] |
+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|includeCloudRequest|N |1 |Boolean| Enable or disable cloud data request |
+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|format |N |1 |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO] |
+-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestList |M |1 |Array |Content of request List. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestList :
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|request |M |1 |request Object |Content of request object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
Request Object
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+===================+=========+===========+==========================+===========================================+
|requestId |M |1 |String |Request Id. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|startTime |M |1 |request Object |Start time. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestScope |M |1 |request Object |Scope of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestType |M |1 |request Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails |M |1 |requestDetails Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestStatus |M |1 |requestStatus Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+===================+==========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters |requestParameters Object |Content of requestParameters object. |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
+-------------------+--------------------------+-------------------------------------------------+
|project |project Object |Content of project object. |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity |owningEntity Object |Content of owningEntity object. |
+-------------------+--------------------------+-------------------------------------------------+
|platform |platform Object |Content of platform object. |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid |String |The Model Customization UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId |String |The Model version id |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid |String |The Model UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid |String |The Model Invariant UUid |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
SubscriberInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|GlobalSubscriberId |String |Global customer Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber |String |billingAccountNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl |String |callbackUrl of the request |
+-------------------------+------------------+-------------------------------------------------+
|correlator |String |correlator of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber |String |orderNumber of the request |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId |String |productFamilyId of the request |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion |String |orderVersion of the request |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |instanceName of the request |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback |String |suppressRollback of the request |
+-------------------------+------------------+-------------------------------------------------+
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|SubscriptionServiceType |String |The service type of the Subscription |
+-------------------------+------------------+-------------------------------------------------+
RequestStatus Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|finishTime |String |Time |
+-------------------------+------------------+-------------------------------------------------+
|requestState |String |state of the request |
+-------------------------+------------------+-------------------------------------------------+
|statusMessage |String |statusMessage |
+-------------------------+------------------+-------------------------------------------------+
|percentProgress |String |percentage of progress |
+-------------------------+------------------+-------------------------------------------------+
.. _healthCheck:
CNF healthCheck
++++++++++++++++
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+===============================================================================================================+
|URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/healthcheck |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+---------------------------------------------------------------------------------------------------------------+
Request Headers:
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name |Required |Description |
+===================+=========+=========================================================================================+
|Authorization |Y |Base64 encoded username:password |
+-------------------+---------+-----------------------------------------------------------------------------------------+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+================+=========+===========+==========================+===========================================+
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=====================+=========================+=================================================+
|modelInfo |modelInfo Object |Content of modelInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
|relatedInstanceList |List |Content of relatedInstanceList. |
+---------------------+-------------------------+-------------------------------------------------+
ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|ModelType |String |Type of model |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId |String |The Model Invariant Id. |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId |String |The modelname Version Id |
+-------------------------+------------------+-------------------------------------------------+
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
+-------------------------+------------------+-------------------------------------------------+
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|InstanceName |String |The instance Name |
+-------------------------+------------------+-------------------------------------------------+
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
|SuppressRollback |Boolean |SuppressRollback |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
+=========================+==================+=================================================+
|instanceId |String |instanceId |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
|instanceName |String |Name of the instance |
+-------------------------+------------------+-------------------------------------------------+