docs/api/apis/e2eServiceInstances-api.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018 Huawei Technologies Co., Ltd.
   4
   5 e2eServiceInstances API
   6 =======================
   7
   8 This API allows to manage:
   9
  10 - e2eServiceInstances (create and delete)
  11 - operations on e2eServiceInstances (get)
  12
  13
  14 Create E2E service instance
  15 +++++++++++++++++++++++++++
  16
  17 +--------------------+------------------------------------------------------------+
  18 |Interface Definition|Description                                                 |
  19 +====================+============================================================+
  20 |URI                 |/onap/so/infra/e2eServiceInstances/v3                       |
  21 +--------------------+------------------------------------------------------------+
  22 |Operation Type      |POST                                                        |
  23 +--------------------+------------------------------------------------------------+
  24 |Content-Type        |application/json                                            |
  25 +--------------------+------------------------------------------------------------+
  26
  27 Request Body:
  28
  29 +---------+---------+-----------+--------------------------+-----------------------------+
  30 |Attribute|Qualifier|Cardinality|Content                   |Description                  |
  31 +=========+=========+===========+==========================+=============================+
  32 |service  |M        |1          |Service Object            |Content of service object.   |
  33 +---------+---------+-----------+--------------------------+-----------------------------+
  34
  35 Service Object
  36
  37 +------------------------------+-----------------+------------------------------------+
  38 |Attribute                     |Content          |Description                         |
  39 +==============================+=================+====================================+
  40 |name                          |String           |Service instance name.              |
  41 +------------------------------+-----------------+------------------------------------+
  42 |description                   |String           |Service instance description        |
  43 +------------------------------+-----------------+------------------------------------+
  44 |serviceUuid                   |String           |Model UUID                          |
  45 +------------------------------+-----------------+------------------------------------+
  46 |serviceInvariantUuid          |String           |Model Invariant UUID                |
  47 +------------------------------+-----------------+------------------------------------+
  48 |gloabalSubscriberId           |String           |Customer Id                         |
  49 +------------------------------+-----------------+------------------------------------+
  50 |serviceType                   |String           |service Type                        |
  51 +------------------------------+-----------------+------------------------------------+
  52 |parameters                    |Object           |Parameter Object                    |
  53 +------------------------------+-----------------+------------------------------------+
  54
  55 Parameter Object
  56
  57 +------------------------------+-----------------+------------------------------------+
  58 |Attribute                     |Content          |Description                         |
  59 +==============================+=================+====================================+
  60 |locationConstraints           |List of object   |location infor for each vnf         |
  61 +------------------------------+-----------------+------------------------------------+
  62 |resource                      |List of Resource |resource of service/resource        |
  63 +------------------------------+-----------------+------------------------------------+
  64 |requestInputs                 |key-value map    |input of service/resource           |
  65 +------------------------------+-----------------+------------------------------------+
  66
  67 LocationConstraint Object
  68
  69 +------------------------------+-----------------+------------------------------------+
  70 |Attribute                     |Content          |Description                         |
  71 +==============================+=================+====================================+
  72 |vnfProfileId                  |String           |Customization id for VNF            |
  73 +------------------------------+-----------------+------------------------------------+
  74 |locationConstraints           |Object           |DC location info of VNF             |
  75 +------------------------------+-----------------+------------------------------------+
  76
  77 VnfLocationConstraint Object
  78
  79 +------------------------------+-----------------+------------------------------------+
  80 |Attribute                     |Content          |Description                         |
  81 +==============================+=================+====================================+
  82 |vimId                         |String           |VIM id from ESR definition          |
  83 +------------------------------+-----------------+------------------------------------+
  84
  85 Resource Object
  86
  87 +------------------------------+-----------------+------------------------------------+
  88 |Attribute                     |Content          |Description                         |
  89 +==============================+=================+====================================+
  90 |resourceName                  |String           |The resource name                   |
  91 +------------------------------+-----------------+------------------------------------+
  92 |resourceInvariantUuid         |String           |The resource invariant UUID.        |
  93 +------------------------------+-----------------+------------------------------------+
  94 |resourceUuid                  |String           |The resource UUID.                  |
  95 +------------------------------+-----------------+------------------------------------+
  96 |resourceCustomizationUuid     |String           |The resource customization UUID.    |
  97 +------------------------------+-----------------+------------------------------------+
  98 |parameters                    |Object           |Parameter of resource               |
  99 +------------------------------+-----------------+------------------------------------+
 100
 101 Response:
 102
 103 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 104 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
 105 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 106 |serviceId    |M        |1          |String |Service instance ID.                                                    |
 107 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 108 |operationId  |M        |1          |String |Service Operation ID.                                                   |
 109 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 110
 111 Delete E2E service instance
 112 +++++++++++++++++++++++++++
 113
 114 +--------------------+----------------------------------------------------------------------+
 115 |Interface Definition|Description                                                           |
 116 +====================+======================================================================+
 117 |URI                 |/onap/so/infra/e2eServiceInstances/v3/{serviceId}                     |
 118 +--------------------+----------------------------------------------------------------------+
 119 |Operation Type      |DELETE                                                                |
 120 +--------------------+----------------------------------------------------------------------+
 121
 122 Request Parameters:
 123
 124 +-------------------+---------+-----------+-------+----------------------------------------+
 125 |Attribute          |Qualifier|Cardinality|Content|Description                             |
 126 +===================+=========+===========+=======+========================================+
 127 |globalSubscriberId |M        |1          |String |The subscriber id. It is defined in AAI |
 128 +-------------------+---------+-----------+-------+----------------------------------------+
 129 |serviceType        |M        |1          |String |The service type. It is defined in AAI  |
 130 +-------------------+---------+-----------+-------+----------------------------------------+
 131
 132 Response:
 133
 134 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 135 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
 136 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 137 |operationId  |M        |1          |String |The operation id.                                                       |
 138 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
 139
 140 Query E2E service operation result
 141 ++++++++++++++++++++++++++++++++++
 142
 143 +--------------------+-----------------------------------------------------------------------------------------------+
 144 |Interface Definition|Description                                                                                    |
 145 +====================+===============================================================================================+
 146 |URI                 |/onap/so/infra/e2eServiceInstances/v3/{serviceId}/operations/{operationId}                     |
 147 +--------------------+-----------------------------------------------------------------------------------------------+
 148 |Operation Type      |GET                                                                                            |
 149 +--------------------+-----------------------------------------------------------------------------------------------+
 150
 151 Request Parameters:
 152
 153 +--------------+---------+-----------+-------+--------------+
 154 |Attribute     |Qualifier|Cardinality|Content|Description   |
 155 +==============+=========+===========+=======+==============+
 156 |serviceId     |M        |1          |Service instance ID.  |
 157 +--------------+---------+-----------+-------+--------------+
 158 |operationId   |M        |1          |Service Operation ID. |
 159 +--------------+---------+-----------+-------+--------------+
 160
 161 Response:
 162
 163 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 164 |Attribute         |Qualifier|Cardinality|Content|Description                                                             |
 165 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 166 |operation         |M        |1          |String |Operation object identify.                                              |
 167 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 168 |operationId       |M        |1          |String |Operation ID.                                                           |
 169 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 170 |operation         |M        |1          |String |Operation type, create|delete.                                          |
 171 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 172 |result            |M        |1          |String |Operation result: finished, error, processing.                          |
 173 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 174 |reason            |M        |1          |String |If failing, need to write fail reason.                                  |
 175 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 176 |userId            |M        |1          |String |Operation user ID.                                                      |
 177 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 178 |operationContent  |M        |1          |String |The status detail of current operation which is being executing.        |
 179 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 180 |progress          |M        |1          |String |Current operation progress.                                             |
 181 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 182 |operateAt         |M        |1          |String |Time that it starts to execute operation.                               |
 183 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
 184 |finishedAt        |M        |1          |String |Time that it finished executing operation.                              |
 185 +------------------+---------+-----------+-------+------------------------------------------------------------------------+