[SO] Documentation for ASD/CNFM

[so.git] / docs / api / apis / serviceInstances-api.rst

diff --git a/docs/api/apis/serviceInstances-api.rst b/docs/api/apis/serviceInstances-api.rst
index b3fd2cf..6f7e787 100644 (file)
--- a/docs/api/apis/serviceInstances-api.rst
+++ b/docs/api/apis/serviceInstances-api.rst
@@ -13,6 +13,7 @@ This API allows to generate some requests to manage:
 - vfModules attached to a vnf instance (create, delete)
 - vnfs attached to a service instance (create, delete)
 - orchestrationRequests (get)
+- CNF healthCheck
 
 links:
 
@@ -24,9 +25,11 @@ links:
 - :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:
 
@@ -36,13 +39,21 @@ Create service instance
 +--------------------+--------------------------------------------------------+
 |Interface Definition|Description                                             |
 +====================+========================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6                      |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -231,13 +242,21 @@ Delete service instance
 +--------------------+--------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                     |
 +====================+================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -287,13 +306,21 @@ Create Volume Group
 +--------------------+------------------------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                                       |
 +====================+==================================================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -420,13 +447,21 @@ Delete Volume Group
 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                                                                 |
 +====================+============================================================================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id}                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -483,13 +518,21 @@ Create VF Module
 +--------------------+---------------------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                                    |
 +====================+===============================================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -580,13 +623,21 @@ Delete VF Module
 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                                                          |
 +====================+=====================================================================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -652,13 +703,21 @@ Create VNF
 +--------------------+-------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                          |
 +====================+=====================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -801,13 +860,21 @@ Delete VNF
 +--------------------+-----------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                          |
 +====================+=====================================================================================================+
-|URI                 |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}                          |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -876,6 +943,244 @@ UserParams Object
 |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
@@ -884,13 +1189,21 @@ GET Orchestration Request
 +--------------------+-------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                          |
 +====================+=====================================================================================+
-|URI                 |/onap/so/infra/orchestrationRequests/v6/{request-id}                                 |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -1038,13 +1351,44 @@ GET Orchestration Requests
 +--------------------+--------------------------------------------------------------+
 |Interface Definition|Description                                                   |
 +====================+==============================================================+
-|URI                 |/onap/so/infra/orchestrationRequests/v6                       |
+|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:
 
 +----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -1190,3 +1534,108 @@ RequestStatus Object
 +-------------------------+------------------+-------------------------------------------------+
 |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                             |
++-------------------------+------------------+-------------------------------------------------+
\ No newline at end of file