docs/sections/apis/ves.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3
   4 VES-Collector
   5 =============
   6
   7 .. toctree::
   8     :maxdepth: 3
   9
  10 Description
  11 ~~~~~~~~~~~
  12
  13 Virtual Event Streaming (VES) Collector is RESTful collector for processing
  14 JSON messages. The collector verifies the source and validates the events
  15 against VES schema before distributing to DMAAP MR topics.
  16
  17 .. csv-table::
  18    :header: "API name", "Swagger JSON", "Swagger YAML"
  19    :widths: 10,5,5
  20
  21    "VES Collector", ":download:`link <swagger_vescollector.json>`", ":download:`link <swagger_vescollector.yaml>`"
  22
  23 Contact Information
  24 ~~~~~~~~~~~~~~~~~~~
  25
  26 onap-discuss@lists.onap.org
  27
  28 Security
  29 ~~~~~~~~
  30
  31 `VES Authentication Types <https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/ves-http/tls-authentication.html>`_
  32
  33
  34 VES Specification
  35 ~~~~~~~~~~~~~~~~~
  36
  37 - `VES 7.1.1 Data Model <https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves7_1spec.html#common-event-format>`_
  38 - `VES 5.4 Data Model <https://docs.onap.org/projects/onap-vnfrqts-requirements/en/latest/Chapter8/ves_5_4_1/VESEventListener.html#common-event-format>`_
  39
  40
  41 Response Code
  42 ~~~~~~~~~~~~~
  43
  44 +-----+--------------+--------------------------------------------------------+
  45 | Code| Reason Phrase| Description                                            |
  46 +=====+==============+========================================================+
  47 | 202 | Accepted     | The request has been accepted for processing           |
  48 +-----+--------------+--------------------------------------------------------+
  49 | 400 | Bad Request  | Many possible reasons not specified by the other codes |
  50 |     |              | (e.g., missing required parameters or incorrect format)|
  51 |     |              | . The response body may include a further exception    |
  52 |     |              | code and text. HTTP 400 errors may be mapped to SVC0001|
  53 |     |              | (general service error), SVC0002 (bad parameter),      |
  54 |     |              | SVC2000 (general service error with details) or PO9003 |
  55 |     |              | (message content size exceeds the allowable limit).    |
  56 +-----+--------------+--------------------------------------------------------+
  57 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401    |
  58 |     |              | errors may be mapped to POL0001 (general policy error) |
  59 |     |              | or POL2000 (general policy error with details).        |
  60 +-----+--------------+--------------------------------------------------------+
  61 | 404 | Not Found    | The server has not found anything matching the         |
  62 |     |              | Request-URI. No indication is given of whether the     |
  63 |     |              | condition is temporary or permanent.                   |
  64 +-----+--------------+--------------------------------------------------------+
  65 | 405 | Method Not   | A request was made of a resource using a request method|
  66 |     | Allowed      | not supported by that resource (e.g., using PUT on a   |
  67 |     |              | REST resource that only supports POST).                |
  68 +-----+--------------+--------------------------------------------------------+
  69 | 500 | Internal     | The server encountered an internal error or timed out; |
  70 |     | Server Error | please retry (general catch-all server-side error).HTTP|
  71 |     |              | 500 errors may be mapped to SVC1000 (no server         |
  72 |     |              | resources).                                            |
  73 +-----+--------------+--------------------------------------------------------+
  74
  75 Sample Request and Response
  76 ---------------------------
  77
  78 Request Example
  79
  80
  81 .. code-block:: http
  82
  83     POST  /eventListener/v7 HTTP/1.1
  84     Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
  85     content-type: application/json
  86     content-length: 12345
  87     X-MinorVersion: 1
  88
  89     {
  90         "event": {
  91             "commonEventHeader": {
  92                 "version": "4.1",
  93                 "vesEventListenerVersion": "7.1.1",
  94                 "domain": "fault",
  95                 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
  96                 "eventId": "fault0000245",
  97                 "sequence": 1,
  98                 "priority": "High",
  99                 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
 100                 "reportingEntityName": "ibcx0001vm002oam001",
 101                 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
 102                 "sourceName": "scfx0001vm002cap001",
 103                 "nfVendorName": "Ericsson",
 104                 "nfNamingCode": "scfx",
 105                 "nfcNamingCode": "ssc",
 106                 "startEpochMicrosec": 1413378172000000,
 107                 "lastEpochMicrosec": 1413378172000000,
 108                 "timeZoneOffset": "UTC-05:30"
 109             },
 110             "faultFields": {
 111                 "faultFieldsVersion": 4.0,
 112                 "alarmCondition": "PilotNumberPoolExhaustion",
 113                 "eventSourceType": "other",
 114                 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
 115                 "eventSeverity": "CRITICAL",
 116                 "vfStatus": "Active",
 117                 "alarmAdditionalInformation": {
 118                     "PilotNumberPoolSize": "1000"
 119                 }
 120             }
 121         }
 122     }
 123
 124
 125
 126 Response Example
 127
 128 .. code-block:: http
 129
 130     HTTPS/1.1 202 Accepted
 131     X-MinorVersion: 1
 132     X-PatchVersion: 1
 133     X-LatestVersion: 7.1.1