diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 26 | ||||
| -rw-r--r-- | docs/offeredapis.rst | 12 | ||||
| -rw-r--r-- | docs/sections/apis/cdapbroker.rst | 996 | ||||
| -rw-r--r-- | docs/sections/apis/cdapbroker.yaml | 418 | ||||
| -rw-r--r-- | docs/sections/apis/config_binding.rst | 113 | ||||
| -rw-r--r-- | docs/sections/apis/config_binding.yaml | 33 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler-API.yaml | 479 | ||||
| -rw-r--r-- | docs/sections/apis/deploymenthandler.rst | 1041 | ||||
| -rw-r--r-- | docs/sections/apis/inventory_api.rst | 1642 | ||||
| -rw-r--r-- | docs/sections/apis/inventory_api.yaml | 680 | ||||
| -rw-r--r-- | docs/sections/apis/ves.rst | 2835 | ||||
| -rw-r--r-- | docs/sections/apis/ves.yaml | 1927 | ||||
| -rw-r--r-- | docs/sections/architecture.rst | 48 | ||||
| -rw-r--r-- | docs/sections/consumedapis.rst | 5 | ||||
| -rw-r--r-- | docs/sections/offeredapis.rst | 28 |
15 files changed, 10214 insertions, 69 deletions
diff --git a/docs/index.rst b/docs/index.rst index 128a7ee5..b37fed42 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,30 +6,6 @@ Data Collection, Analytics, and Events (DCAE) ======================= .. Add or remove sections below as appropriate for the platform component. -Data Collection Analytics and Events (DCAE) is the data collection and analysis subsystem of ONAP. -Its functions include collection of FCAPs data from the network entotiess (VNFs, PNFs, etc), normalization and transportation of -data, analysis of data, and generations of ONAP events which can be received by other ONAP components such as Policy for -subsequent operations. - -DCAE consists of DCAE Platform components and DCAE Services components. - -- DCAE Platform - - Core Platform - - Cloudify Manager - - Consul - - Extended Platform - - Docker Host for containerized platform components - - CDAP Analytics Platform for CDAP analytics applications - - Docker Host for containerized service components - - -- DCAE Services - - Collectors - - Virtual Event Streaming (VES) collector, dockerized - - SNMP Trap collector, dockerized - - Analytics - - Holmes correlation analytics, dockerized - - Threshold Crosssing Analytics (TCA), CDAP analytics application .. toctree:: :maxdepth: 1 @@ -45,5 +21,3 @@ DCAE consists of DCAE Platform components and DCAE Services components. ./sections/humaninterfaces.rst ./sections/release-notes.rst - offeredapis.rst - diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst deleted file mode 100644 index bbd2f6c4..00000000 --- a/docs/offeredapis.rst +++ /dev/null @@ -1,12 +0,0 @@ -DCAEGEN2 Components Offered APIs -================================== - -- `CDAP Broker Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/cdapbroker.git;a=blob_plain;f=swagger/swagger.yaml;hb=HEAD>`_. - -- `Config Binding Service Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/configbinding.git;a=blob_plain;f=config_binding_service/swagger/swagger.yaml;hb=HEAD>`_. - -- `Deployment Handler Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/deployment-handler.git;a=blob_plain;f=deployment-handler-API.yaml;hb=HEAD>`_. - -- `Inventory API Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/inventory-api.git;a=blob_plain;f=swagger_inventory.yaml;hb=HEAD>`_. - -- `VES Collector Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob_plain;f=swagger_vescollector.yaml;hb=HEAD>`_. diff --git a/docs/sections/apis/cdapbroker.rst b/docs/sections/apis/cdapbroker.rst new file mode 100644 index 00000000..c145dbce --- /dev/null +++ b/docs/sections/apis/cdapbroker.rst @@ -0,0 +1,996 @@ +CDAP Broker API 4.0.10 +====================== + +.. toctree:: + :maxdepth: 3 + + + + + +DEFAULT +~~~~~~~ + + + + +DELETE ``/application/{appname}`` +--------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Remove an app for service and configuration discovery. This will remove the metrics and health endpoints for this app. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | text | | Name of the application. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +**404** +^^^^^^^ + +no app with name 'appname' registered with this broker. + + + + + + +GET ``/`` +--------- + + + +Description ++++++++++++ + +.. raw:: html + + shows some information about this service + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +successful response + + +Type: :ref:`info <d_060ca512d6d771a97a7d0f50886f6b14>` + +**Example:** + +.. code-block:: javascript + + { + "broker API version": "somestring", + "cdap GUI port": 1, + "cdap cluster version": "somestring", + "managed cdap url": "somestring", + "number of applications registered": 1, + "uptime (s)": 1 + } + + + + + +GET ``/application`` +-------------------- + + + +Description ++++++++++++ + +.. raw:: html + + get all applications registered with this broker + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +successful response + + +Type: array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` + + +**Example:** + +.. code-block:: javascript + + [ + "somestring", + "somestring" + ] + + + + + +GET ``/application/{appname}`` +------------------------------ + + + +Description ++++++++++++ + +.. raw:: html + + Returns the representation of the application resource, including the links for healthcheck and metrics. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | text | | Name of the application. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` + +**Example:** + +.. code-block:: javascript + + { + "appname": "somestring", + "connectionurl": "somestring", + "healthcheckurl": "somestring", + "metricsurl": "somestring", + "serviceendpoints": [ + { + "method": "somestring", + "url": "somestring" + }, + { + "method": "somestring", + "url": "somestring" + } + ], + "url": "somestring" + } + +**404** +^^^^^^^ + +no app with name 'appname' registered with this broker. + + + + + + +GET ``/application/{appname}/healthcheck`` +------------------------------------------ + + + +Description ++++++++++++ + +.. raw:: html + + Perform a healthcheck on the running app appname. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | test | | Name of the application to get the healthcheck for. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response, healthcheck pass + + +**404** +^^^^^^^ + +no app with name 'appname' registered with this broker, or the healthcheck has failed (though I would like to disambiguiate from the first case, CDAP returns a 404 for this). + + + + + + +GET ``/application/{appname}/metrics`` +-------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get live (real-time) app specific metrics for the running app appname. Metrics are customized per each app by the component developer + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | test | | Name of the application to get metrics for. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +Type: :ref:`MetricsObject <d_5d4c5a47c1043833affa67eb27bf3d9d>` + +**Example:** + +.. code-block:: javascript + + { + "appmetrics": {} + } + +**404** +^^^^^^^ + +no app with name 'appname' registered with this broker. + + + + + + +POST ``/application/delete`` +---------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + endpoint to delete multiple applications at once. Returns an array of status codes, where statuscode[i] = response returned from DELETE(application/i) + + +Request ++++++++ + + + +.. _d_c0830b0f8b495da06c2fef152ce05dba: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + appnames | No | array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` | | | + +.. code-block:: javascript + + { + "appnames": [ + "somestring", + "somestring" + ] + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +successful response + + +Type: array of :ref:`returncode <d_5a28f16eed72be7d9a8279c0e1f05386>` + + +**Example:** + +.. code-block:: javascript + + [ + 1, + 1 + ] + + + + + +PUT ``/application/{appname}`` +------------------------------ + + + +Description ++++++++++++ + +.. raw:: html + + Register an app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | text | | Name of the application. + + +Request ++++++++ + + + +.. _d_a151b00939024528c17a91cf47a4eae3: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + app_config | No | :ref:`app_config <i_13b2658afc25a955a6b4b48b9898c1a3>` | | | the application config JSON + app_preferences | No | :ref:`app_preferences <i_57297f6d8a6251aeb045f0872bf38d81>` | | | the application preferences JSON + artifact_name | No | string | | | the name of the CDAP artifact to be added + cdap_application_type | No | string | | {'enum': ['program-flowlet']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be 'program-flowlet' + jar_url | No | string | | | the URL that the JAR you're deploying resides + namespace | No | string | | | the cdap namespace this is deployed into + program_preferences | No | array of :ref:`programpref <d_610742fa78204adc388d0f7fbe30ad61>` | | | + programs | No | array of :ref:`programs <d_7bc8b39312a070aee5928f4e730192ae>` | | | + services | No | array of :ref:`service_endpoint <d_ad781f0dd64e16123fc1cbfefb4b9ded>` | | | + streamname | No | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + +.. _i_13b2658afc25a955a6b4b48b9898c1a3: + +**App_config schema:** + + +the application config JSON + + + +.. _i_57297f6d8a6251aeb045f0872bf38d81: + +**App_preferences schema:** + + +the application preferences JSON + + + +.. code-block:: javascript + + { + "app_config": {}, + "app_preferences": {}, + "artifact_name": "somestring", + "cdap_application_type": "program-flowlet", + "jar_url": "somestring", + "namespace": "somestring", + "program_preferences": [ + { + "program_id": "somestring", + "program_pref": {}, + "program_type": "somestring" + }, + { + "program_id": "somestring", + "program_pref": {}, + "program_type": "somestring" + } + ], + "programs": [ + { + "program_id": "somestring", + "program_type": "somestring" + }, + { + "program_id": "somestring", + "program_type": "somestring" + } + ], + "services": [ + { + "endpoint_method": "somestring", + "service_endpoint": "somestring", + "service_name": "somestring" + }, + { + "endpoint_method": "somestring", + "service_endpoint": "somestring", + "service_name": "somestring" + } + ], + "streamname": "somestring" + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` + +**Example:** + +.. code-block:: javascript + + { + "appname": "somestring", + "connectionurl": "somestring", + "healthcheckurl": "somestring", + "metricsurl": "somestring", + "serviceendpoints": [ + { + "method": "somestring", + "url": "somestring" + }, + { + "method": "somestring", + "url": "somestring" + } + ], + "url": "somestring" + } + +**400** +^^^^^^^ + +put was performed but the appname was already registered with the broker, or Invalid PUT body + + + + + + +PUT ``/application*/{appname}`` +------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + (This is a hacky way of supporting "oneOf" because Swagger does not support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. This is the same endpoint as PUT /application/appname, except the PUT body is different.) + +Register a hydrator app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | text | | Name of the application. + + +Request ++++++++ + + + +.. _d_d43078a75182938dccdbeac654cea43c: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + cdap_application_type | Yes | string | | {'enum': ['hydrator-pipeline']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be 'hydrator-pipeline' + dependencies | No | array of :ref:`hydratordep <d_c5aa8c778f283571705fbe7a21d0f5c7>` | | | represents a list of dependencies to be loaded for this pipeline. Not required. + namespace | Yes | string | | | the cdap namespace this is deployed into + pipeline_config_json_url | Yes | string | | | the URL of the config.json for this pipeline + streamname | Yes | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + +.. code-block:: javascript + + { + "cdap_application_type": "hydrator-pipeline", + "dependencies": [ + { + "artifact_extends_header": "somestring", + "artifact_name": "somestring", + "artifact_url": "somestring", + "artifact_version_header": "somestring", + "ui_properties_url": "somestring" + }, + { + "artifact_extends_header": "somestring", + "artifact_name": "somestring", + "artifact_url": "somestring", + "artifact_version_header": "somestring", + "ui_properties_url": "somestring" + } + ], + "namespace": "somestring", + "pipeline_config_json_url": "somestring", + "streamname": "somestring" + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` + +**Example:** + +.. code-block:: javascript + + { + "appname": "somestring", + "connectionurl": "somestring", + "healthcheckurl": "somestring", + "metricsurl": "somestring", + "serviceendpoints": [ + { + "method": "somestring", + "url": "somestring" + }, + { + "method": "somestring", + "url": "somestring" + } + ], + "url": "somestring" + } + +**400** +^^^^^^^ + +put was performed but the appname was already registered with the broker, or Invalid PUT body + + + + + + +PUT ``/application/{appname}/reconfigure`` +------------------------------------------ + + + +Description ++++++++++++ + +.. raw:: html + + Reconfigures the application. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + appname | path | Yes | string | text | | Name of the application. + + +Request ++++++++ + + + +.. _d_2a32645bc6d3020744d3d17500c34bc3: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + config | Yes | :ref:`config <i_6a9d9951a40bf655fda365aa310e1ddc>` | | | the config JSON + reconfiguration_type | Yes | string | | {'enum': ['program-flowlet-app-config', 'program-flowlet-app-preferences', 'program-flowlet-smart']} | the type of reconfiguration + +.. _i_6a9d9951a40bf655fda365aa310e1ddc: + +**Config schema:** + + +the config JSON + + + +.. code-block:: javascript + + { + "config": {}, + "reconfiguration_type": "program-flowlet-app-config" + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +**400** +^^^^^^^ + +Bad request. Can happen with 1) {appname} is not registered with the broker, 2) the required PUT body is wrong, or 3) the smart interface was chosen and none of the config keys match anything in app_config or app_preferences + + + + + +Data Structures +~~~~~~~~~~~~~~~ + +.. _d_2b315c86978b3cd8c6edfbe745f1afa2: + +Application Model Structure +--------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + appname | No | string | | | application name + connectionurl | No | string | | | input URL that you can POST data into (URL of the CDAP stream) + healthcheckurl | No | string | | | fully qualified url to perform healthcheck + metricsurl | No | string | | | fully qualified url to get metrics from + serviceendpoints | No | array of :ref:`service_method <d_e5edc5fd82a1190817cf350e70cb7e0e>` | | | a list of HTTP services exposed by this CDAP application + url | No | string | | | fully qualified url of the resource + +.. _d_5d4c5a47c1043833affa67eb27bf3d9d: + +MetricsObject Model Structure +----------------------------- + +key,value object where the key is 'appmetrics' and the value is an app dependent json and specified by the component developer + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + appmetrics | No | :ref:`appmetrics <i_6cb44a56118e2966acccfb86f18d0570>` | | | + +.. _i_6cb44a56118e2966acccfb86f18d0570: + +**Appmetrics schema:** + + + + +.. _d_2f6991f1775468c3ce48a2778455be93: + +appname Model Structure +----------------------- + +an application name + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + appname | No | string | | | an application name + +.. _d_a151b00939024528c17a91cf47a4eae3: + +appput Model Structure +---------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + app_config | No | :ref:`app_config <i_13b2658afc25a955a6b4b48b9898c1a3>` | | | the application config JSON + app_preferences | No | :ref:`app_preferences <i_57297f6d8a6251aeb045f0872bf38d81>` | | | the application preferences JSON + artifact_name | No | string | | | the name of the CDAP artifact to be added + cdap_application_type | No | string | | {'enum': ['program-flowlet']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be 'program-flowlet' + jar_url | No | string | | | the URL that the JAR you're deploying resides + namespace | No | string | | | the cdap namespace this is deployed into + program_preferences | No | array of :ref:`programpref <d_610742fa78204adc388d0f7fbe30ad61>` | | | + programs | No | array of :ref:`programs <d_7bc8b39312a070aee5928f4e730192ae>` | | | + services | No | array of :ref:`service_endpoint <d_ad781f0dd64e16123fc1cbfefb4b9ded>` | | | + streamname | No | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + +.. _i_13b2658afc25a955a6b4b48b9898c1a3: + +**App_config schema:** + + +the application config JSON + + + +.. _i_57297f6d8a6251aeb045f0872bf38d81: + +**App_preferences schema:** + + +the application preferences JSON + + + +.. _d_d43078a75182938dccdbeac654cea43c: + +hydratorappput Model Structure +------------------------------ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + cdap_application_type | Yes | string | | {'enum': ['hydrator-pipeline']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be 'hydrator-pipeline' + dependencies | No | array of :ref:`hydratordep <d_c5aa8c778f283571705fbe7a21d0f5c7>` | | | represents a list of dependencies to be loaded for this pipeline. Not required. + namespace | Yes | string | | | the cdap namespace this is deployed into + pipeline_config_json_url | Yes | string | | | the URL of the config.json for this pipeline + streamname | Yes | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + +.. _d_c5aa8c778f283571705fbe7a21d0f5c7: + +hydratordep Model Structure +--------------------------- + +represents a hydrator pipeline dependency. An equivelent to the following CURLs are formed with the below four params shown in CAPS 'curl -v -w'\n' -X POST http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME -H 'Artifact-Extends:ARTIFACT_EXTENDS_HEADER' -H “Artifact-Version:ARTIFACT_VERSION_HEADER” --data-binary @(DOWNLOADED FROM ARTIFACT_URL)','curl -v -w'\n' -X PUT http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties -d (DOWNLOADED FROM UI_PROPERTIES_URL)' + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + artifact_extends_header | Yes | string | | | the value of the header that gets passed in for artifact-extends, e.g., 'Artifact-Extends:system:cdap-data-pipeline[4.0.1,5.0.0)' + artifact_name | Yes | string | | | the name of the artifact + artifact_url | Yes | string | | | the URL of the artifact JAR + artifact_version_header | Yes | string | | | the value of the header that gets passed in for artifact-version, e.g., 'Artifact-Version:1.0.0-SNAPSHOT' + ui_properties_url | No | string | | | the URL of the properties.json if the custom artifact has UI properties. This is optional. + +.. _d_060ca512d6d771a97a7d0f50886f6b14: + +info Model Structure +-------------------- + +some broker information + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + broker API version | No | string | | | the API version of this running broker + cdap GUI port | No | integer | | | The GUI port of the CDAP cluster this broker is managing. Mostly to help users of this API check their application in cdap. Note, will return UNKNOWN_CDAP_VERSION if it cannot be determined. + cdap cluster version | No | string | | | the version of the CDAP cluster this broker is managing. Note, will return UKNOWN_CDAP_VERSION if it cannot be determined. + managed cdap url | No | string | | | the url of the CDAP cluster API this broker is managing + number of applications registered | No | integer | | | + uptime (s) | No | integer | | | + +.. _d_c0830b0f8b495da06c2fef152ce05dba: + +multideleteput Model Structure +------------------------------ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + appnames | No | array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` | | | + +.. _d_610742fa78204adc388d0f7fbe30ad61: + +programpref Model Structure +--------------------------- + +the list of programs in this CDAP app + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + program_id | No | string | | | the name of the program + program_pref | No | :ref:`program_pref <i_07225a64d44b62a92699f22d603b563c>` | | | the preference JSON to set for this program + program_type | No | string | | | must be one of flows, mapreduce, schedules, spark, workflows, workers, or services + +.. _i_07225a64d44b62a92699f22d603b563c: + +**Program_pref schema:** + + +the preference JSON to set for this program + + + +.. _d_7bc8b39312a070aee5928f4e730192ae: + +programs Model Structure +------------------------ + +the list of programs in this CDAP app + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + program_id | No | string | | | the name of the program + program_type | No | string | | | must be one of flows, mapreduce, schedules, spark, workflows, workers, or services + +.. _d_2a32645bc6d3020744d3d17500c34bc3: + +reconfigput Model Structure +--------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + config | Yes | :ref:`config <i_6a9d9951a40bf655fda365aa310e1ddc>` | | | the config JSON + reconfiguration_type | Yes | string | | {'enum': ['program-flowlet-app-config', 'program-flowlet-app-preferences', 'program-flowlet-smart']} | the type of reconfiguration + +.. _i_6a9d9951a40bf655fda365aa310e1ddc: + +**Config schema:** + + +the config JSON + + + +.. _d_5a28f16eed72be7d9a8279c0e1f05386: + +returncode Model Structure +-------------------------- + +an httpreturncode + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + returncode | No | integer | | | an httpreturncode + +.. _d_ad781f0dd64e16123fc1cbfefb4b9ded: + +service_endpoint Model Structure +-------------------------------- + +descirbes a service endpoint, including the service name, the method name, and the method type (GET, PUT, etc, most of the time will be GET) + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + endpoint_method | No | string | | | GET, POST, PUT, etc + service_endpoint | No | string | | | the name of the endpoint on the service + service_name | No | string | | | the name of the service + +.. _d_e5edc5fd82a1190817cf350e70cb7e0e: + +service_method Model Structure +------------------------------ + +a URL and HTTP method exposed via a CDAP service + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + method | No | string | | | HTTP method you can perform on the URL, e.g., GET, PUT, etc + url | No | string | | | the fully qualified URL in CDAP for this service + diff --git a/docs/sections/apis/cdapbroker.yaml b/docs/sections/apis/cdapbroker.yaml new file mode 100644 index 00000000..41ba163e --- /dev/null +++ b/docs/sections/apis/cdapbroker.yaml @@ -0,0 +1,418 @@ +# Example YAML to get you started quickly. +# Be aware that YAML has indentation based scoping. +# Code completion support is available so start typing for available options. +swagger: '2.0' + +# This is your document metadata +info: + version: "4.0.10" + title: CDAP Broker API + +paths: + /: + get: + description: shows some information about this service + responses: + 200: + description: successful response + schema: + $ref: '#/definitions/info' + + /application: + get: + description: get all applications registered with this broker + responses: + 200: + description: successful response + schema: + type: array + items: + $ref: '#/definitions/appname' + + /application/delete: + post: + description: endpoint to delete multiple applications at once. Returns an array of status codes, where statuscode[i] = response returned from DELETE(application/i) + parameters: + - name: postbody + in: body + description: required post body + required: true + schema: + $ref: '#/definitions/multideleteput' + responses: + 200: + description: successful response + schema: + type: array + items: + $ref: '#/definitions/returncode' + + /application/{appname}: + parameters: + - name: appname + in: path + description: Name of the application. + required: true + type: string + format: text + + get: + description: Returns the representation of the application resource, including the links for healthcheck and metrics. + responses: + 200: + description: Successful response + schema: + $ref: '#/definitions/Application' + 404: + description: no app with name 'appname' registered with this broker. + + put: + description: Register an app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. + consumes: + - application/json + produces: + - application/json + parameters: + - name: putbody + in: body + description: required put body + required: true + schema: + $ref: '#/definitions/appput' + + responses: + 200: + description: Successful response + schema: + $ref: '#/definitions/Application' + 400: + description: put was performed but the appname was already registered with the broker, or Invalid PUT body + + + delete: + description: Remove an app for service and configuration discovery. This will remove the metrics and health endpoints for this app. + responses: + 200: + description: Successful response + 404: + description: no app with name 'appname' registered with this broker. + + /application*/{appname}: + parameters: + - name: appname + in: path + description: Name of the application. + required: true + type: string + format: text + + put: + description: (This is a hacky way of supporting "oneOf" because Swagger does not support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. This is the same endpoint as PUT /application/appname, except the PUT body is different.) + + + Register a hydrator app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. + consumes: + - application/json + produces: + - application/json + parameters: + - name: putbody + in: body + description: required put body + required: true + schema: + $ref: '#/definitions/hydratorappput' + + responses: + 200: + description: Successful response + schema: + $ref: '#/definitions/Application' + 400: + description: put was performed but the appname was already registered with the broker, or Invalid PUT body + + + /application/{appname}/metrics: + get: + # This is array of GET operation parameters: + description: Get live (real-time) app specific metrics for the running app appname. Metrics are customized per each app by the component developer + parameters: + # An example parameter that is in query and is required + - name: appname + in: path + description: Name of the application to get metrics for. + required: true + type: string + format: test + + # Expected responses for this operation: + responses: + 200: + description: Successful response + schema: + $ref: '#/definitions/MetricsObject' + 404: + description: no app with name 'appname' registered with this broker. + + /application/{appname}/healthcheck: + get: + # This is array of GET operation parameters: + description: Perform a healthcheck on the running app appname. + parameters: + # An example parameter that is in query and is required + - name: appname + in: path + description: Name of the application to get the healthcheck for. + required: true + type: string + format: test + + # Expected responses for this operation: + responses: + # Response code + 200: + description: Successful response, healthcheck pass + 404: + description: no app with name 'appname' registered with this broker, or the healthcheck has failed (though I would like to disambiguiate from the first case, CDAP returns a 404 for this). + + /application/{appname}/reconfigure: + parameters: + - name: appname + in: path + description: Name of the application. + required: true + type: string + format: text + put: + description: Reconfigures the application. + parameters: + - name: putbody + in: body + description: required put body + required: true + schema: + $ref: '#/definitions/reconfigput' + responses: + 200: + description: Successful response + 400: + description: Bad request. Can happen with 1) {appname} is not registered with the broker, 2) the required PUT body is wrong, or 3) the smart interface was chosen and none of the config keys match anything in app_config or app_preferences + +definitions: + MetricsObject: + type: object + description: key,value object where the key is 'appmetrics' and the value is an app dependent json and specified by the component developer + properties: + appmetrics: + type: object + + Application: + type: object + properties: + appname: + description: application name + type: string + healthcheckurl: + description: fully qualified url to perform healthcheck + type: string + metricsurl: + description: fully qualified url to get metrics from + type: string + url: + description: fully qualified url of the resource + type: string + connectionurl: + description: input URL that you can POST data into (URL of the CDAP stream) + type: string + serviceendpoints: + description: a list of HTTP services exposed by this CDAP application + type: array + items: + $ref: '#/definitions/service_method' + + reconfigput: + type: object + properties: + reconfiguration_type: + description: the type of reconfiguration + type: string + enum: ["program-flowlet-app-config", "program-flowlet-app-preferences", "program-flowlet-smart"] + config: + description: the config JSON + type: object + required: ["reconfiguration_type", "config"] + + multideleteput: + type: object + properties: + appnames: + type: array + items: + $ref: '#/definitions/appname' + + appname: + description: an application name + type: string + + hydratorappput: + type: object + properties: + cdap_application_type: + description: denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be "hydrator-pipeline" + type: string + enum: ["hydrator-pipeline"] + namespace: + description: the cdap namespace this is deployed into + type: string + pipeline_config_json_url: + description: the URL of the config.json for this pipeline + type: string + streamname: + description: name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + type: string + dependencies: + description: represents a list of dependencies to be loaded for this pipeline. Not required. + type: array + items: + $ref: '#/definitions/hydratordep' + required: ["cdap_application_type", "namespace", "pipeline_config_json_url", "streamname"] + + appput: + type: object + properties: + cdap_application_type: + description: denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be "program-flowlet" + type: string + enum: ["program-flowlet"] + streamname: + description: name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. + type: string + namespace: + description: the cdap namespace this is deployed into + type: string + jar_url: + description: the URL that the JAR you're deploying resides + type: string + artifact_name: + description: the name of the CDAP artifact to be added + type: string + artifact_ver: + description: the version of the artifact. Must be in X.Y.Z form + app_config: + description: the application config JSON + type: object + app_preferences: + description: the application preferences JSON + type: object + programs: + type: array + items: + $ref: '#/definitions/programs' + program_preferences: + type: array + items: + $ref: '#/definitions/programpref' + services: + type: array + items: + $ref: '#/definitions/service_endpoint' + + service_endpoint: + description: descirbes a service endpoint, including the service name, the method name, and the method type (GET, PUT, etc, most of the time will be GET) + type: object + properties: + service_name: + type: string + description: the name of the service + service_endpoint: + type: string + description: the name of the endpoint on the service + endpoint_method: + type: string + description: GET, POST, PUT, etc + + service_method: + description: a URL and HTTP method exposed via a CDAP service + type: object + properties: + url: + type: string + description: the fully qualified URL in CDAP for this service + method: + type: string + description: HTTP method you can perform on the URL, e.g., GET, PUT, etc + + programs: + description: the list of programs in this CDAP app + type: object + properties: + program_type: + description: must be one of flows, mapreduce, schedules, spark, workflows, workers, or services + type: string + program_id: + description: the name of the program + type: string + + returncode: + description: an httpreturncode + type: integer + + hydratordep: + description: represents a hydrator pipeline dependency. An equivelent to the following CURLs are formed with the below four params shown in CAPS "curl -v -w"\n" -X POST http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME -H "Artifact-Extends:ARTIFACT_EXTENDS_HEADER" -H “Artifact-Version:ARTIFACT_VERSION_HEADER” --data-binary @(DOWNLOADED FROM ARTIFACT_URL)","curl -v -w"\n" -X PUT http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties -d (DOWNLOADED FROM UI_PROPERTIES_URL)" + properties: + artifact_extends_header: + description: the value of the header that gets passed in for artifact-extends, e.g., "Artifact-Extends:system:cdap-data-pipeline[4.0.1,5.0.0)" + type: string + artifact_name: + description: the name of the artifact + type: string + artifact_version_header : + description: the value of the header that gets passed in for artifact-version, e.g., "Artifact-Version:1.0.0-SNAPSHOT" + type: string + artifact_url: + description: the URL of the artifact JAR + type: string + ui_properties_url: + description: the URL of the properties.json if the custom artifact has UI properties. This is optional. + type: string + required: ["artifact_extends_header", "artifact_name", "artifact_version_header", "artifact_url"] + + programpref: + description: the list of programs in this CDAP app + type: object + properties: + program_type: + description: must be one of flows, mapreduce, schedules, spark, workflows, workers, or services + type: string + program_id: + description: the name of the program + type: string + program_pref: + description: the preference JSON to set for this program + type: object + + info: + description: some broker information + type: object + properties: + managed cdap url: + description: the url of the CDAP cluster API this broker is managing + type: string + number of applications registered: + type: integer + uptime (s): + type: integer + cdap GUI port: + type: integer + description: The GUI port of the CDAP cluster this broker is managing. Mostly to help users of this API check their application in cdap. Note, will return UNKNOWN_CDAP_VERSION if it cannot be determined. + cdap cluster version: + type: string + description: the version of the CDAP cluster this broker is managing. Note, will return UKNOWN_CDAP_VERSION if it cannot be determined. + broker API version: + type: string + description: the API version of this running broker + + + + + diff --git a/docs/sections/apis/config_binding.rst b/docs/sections/apis/config_binding.rst new file mode 100644 index 00000000..51074455 --- /dev/null +++ b/docs/sections/apis/config_binding.rst @@ -0,0 +1,113 @@ +Config Binding Service 1.0.0 +============================ + +.. toctree:: + :maxdepth: 3 + + + + + +DEFAULT +~~~~~~~ + + + + +GET ``/service_component/{service_component_name}`` +--------------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Binds the configuration for service_component_name and returns the bound configuration as a JSON + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + service_component_name | path | Yes | string | | | Service Component Name. service_component_name and service_component_name:rels must be keys in consul. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +OK; the bound config is returned as an object + + +.. _i_6cb44a56118e2966acccfb86f18d0570: + +**Response Schema:** + + + + +**Example:** + +.. code-block:: javascript + + {} + +**404** +^^^^^^^ + +there is no configuration in Consul for this component + + + + + + +GET ``/healthcheck`` +-------------------- + + + +Description ++++++++++++ + +.. raw:: html + + This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +**503** +^^^^^^^ + +the config binding service cannot reach Consul + + + + + +Data Structures +~~~~~~~~~~~~~~~ + diff --git a/docs/sections/apis/config_binding.yaml b/docs/sections/apis/config_binding.yaml new file mode 100644 index 00000000..208e4418 --- /dev/null +++ b/docs/sections/apis/config_binding.yaml @@ -0,0 +1,33 @@ +--- +swagger: "2.0" +info: + version: "1.0.0" + title: "Config Binding Service" +paths: + /service_component/{service_component_name}: + parameters: + - name: "service_component_name" + in: "path" + description: "Service Component Name. service_component_name and service_component_name:rels must be keys in consul." + required: true + type: "string" + get: + description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON" + operationId: "config_binding_service.controller.bind_config_for_scn" + responses: + 200: + description: OK; the bound config is returned as an object + schema: + type: object + 404: + description: there is no configuration in Consul for this component + /healthcheck: + get: + description: "This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul" + operationId: "config_binding_service.controller.healthcheck" + parameters: [] + responses: + 200: + description: Successful response + 503: + description: the config binding service cannot reach Consul diff --git a/docs/sections/apis/deployment-handler-API.yaml b/docs/sections/apis/deployment-handler-API.yaml new file mode 100644 index 00000000..31395a5b --- /dev/null +++ b/docs/sections/apis/deployment-handler-API.yaml @@ -0,0 +1,479 @@ +--- + +swagger: '2.0' + +info: + version: "4.1.0" + title: "deployment-handler API" + license: + name: "Apache 2.0" + url: "http://www.apache.org/licenses/LICENSE-2.0.html" + description: | + High-level API for deploying/undeploying composed DCAE services using Cloudify Manager. + +tags: + - name: "info" + description: "version and links" + - name: "dcae-deployments" + description: "operations on dcae-deployments" + - name: "policy" + description: "policy update API consumed by policy-handler and debug API to find policies on components" + +paths: + /: + get: + tags: + - "info" + description: Returns version information and links to API operations + produces: + - "application/json" + responses: + + 200: + description: Success + schema: + title: DispatcherInfo + type: object + properties: + apiVersion: + type: string + description: | + version of API supported by this server + serverVersion: + type: string + description: | + version of software running on this server + links: + type: object + description: | + Links to API resources + properties: + info: + type: string + description: | + path for the server information endpoint + events: + type: string + description: | + path for the events endpoint + + /dcae-deployments: + get: + tags: + - "dcae-deployments" + description: | + List service deployments known to the orchestrator, optionally restricted to a single service type + + parameters: + - name: serviceTypeId + description: | + Service type identifier for the type whose deployments are to be listed + type: string + in: query + required: false + + responses: + + 200: + description: | + Success. (Note that if no matching deployments are found, the request is still a success; the + deployments array is empty in that case.) + schema: + $ref: "#/definitions/DCAEDeploymentsListResponse" + + 500: + description: | + Problem on the server side. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + 502: + description: | + Error reported to the dispatcher by a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 504: + description: | + Error communicating with a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + /dcae-deployments/{deploymentId}: + put: + tags: + - "dcae-deployments" + description: | + Request deployment of a DCAE service + + consumes: + - application/json + produces: + - application/json + + parameters: + - name: deploymentId + description: | + Unique deployment identifier assigned by the API client. + in: path + type: string + required: true + + - name: body + in: body + schema: + $ref: "#/definitions/DCAEDeploymentRequest" + required: true + + responses: + + 202: + description: | + Success: The content that was posted is valid, the dispatcher has + found the needed blueprint, created an instance of the topology in the orchestrator, + and started an installation workflow. + schema: + $ref: "#/definitions/DCAEDeploymentResponse" + + 400: + description: | + Bad request: See the message in the response for details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 409: + description: | + A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 415: + description: | + Bad request: The Content-Type header does not indicate that the content is + 'application/json' + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 500: + description: | + Problem on the server side. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 502: + description: | + Error reported to the dispatcher by a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 504: + description: | + Error communicating with a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + delete: + tags: + - "dcae-deployments" + description: | + Uninstall the DCAE service and remove all associated data from the orchestrator. + + parameters: + - name: deploymentId + description: | + Deployment identifier for the service to be uninstalled. + in: path + type: string + required: true + + responses: + + 202: + description: | + Success: The dispatcher has initiated the uninstall operation. + schema: + $ref: "#/definitions/DCAEDeploymentResponse" + + 400: + description: | + Bad request: See the message in the response for details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 500: + description: | + Problem on the server side. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 502: + description: | + Error reported to the dispatcher by a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 504: + description: | + Error communicating with a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + /dcae-deployments/{deploymentId}/operation/{operationId}: + get: + tags: + - "dcae-deployments" + description: | + Get status of a deployment operation + parameters: + - name: deploymentId + in: path + type: string + required: true + - name: operationId + in: path + type: string + required: true + + responses: + + 200: + description: Status information retrieved successfully + schema: + $ref: "#/definitions/DCAEOperationStatusResponse" + + 404: + description: The operation information does not exist (possibly because the service has been uninstalled and deleted). + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 500: + description: | + Problem on the server side. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 502: + description: | + Error reported to the dispatcher by a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + 504: + description: | + Error communicating with a downstream system. See the message + in the response for more details. + schema: + $ref: "#/definitions/DCAEErrorResponse" + + /policy: + post: + tags: + - "policy" + description: policy update API consumed by policy-handler + + consumes: + - application/json + produces: + - application/json + + parameters: + - name: body + in: body + schema: + $ref: "#/definitions/DCAEPolicyRequest" + required: true + + responses: + 200: + description: deployment-handler always responds with ok to /policy before processing the request + + /policy/components: + get: + tags: + - "policy" + description: debug API to find policies on components + produces: + - application/json + + responses: + 200: + description: deployment-handler found components with or without policies in cloudify + + +definitions: + + DCAEDeploymentRequest: + description: | + Request for deploying a DCAE service. + type: + object + required: [serviceTypeId] + + properties: + + serviceTypeId: + description: | + The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. + type: string + + inputs: + description: | + Object containing inputs needed by the service blueprint to create an instance of the service. + Content of the object depends on the service being deployed. + type: object + + DCAEDeploymentResponse: + description: | + Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} + type: object + + required: [requestId, links] + + properties: + requestId: + type: string + description: | + Unique identifier for the request + links: + description: | + Links that the API client can access. + type: object + properties: + self: + type: string + description: | + Link used to retrieve information about the service being deployed + status: + type: string + description: + Link used to retrieve information about the status of the installation workflow + + DCAEOperationStatusResponse: + description: | + Response body for a request for status of an installation or uninstallation operation. + type: object + + required: [requestId, operationType, status] + + properties: + requestId: + type: string + description: | + A unique identifier assigned to the request. Useful for tracing a request through logs. + operationType: + description: | + Type of operation being reported on. ("install" or "uninstall") + type: string + status: + description: | + Status of the installation or uninstallation operation. Possible values are "processing", + "succeeded", and "failed" + type: string + error: + description: | + If status is "failed", this field will be present and contain additional information about the reason the operation failed. + type: string + links: + description: | + If the operation succeeded, links that the client can follow to take further action. Note that a successful "uninstall" operation removes the DCAE service instance completely, so there are no possible further actions, and no links. + type: object + properties: + self: + type: string + description: | + Link used to retrieve information about the service. + uninstall: + type: string + description: + Link used to trigger an "uninstall" operation for the service. (Use the DELETE method.) + + DCAEErrorResponse: + description: | + Object reporting an error. + type: + object + required: [status] + + properties: + status: + description: HTTP status code for the response + type: integer + + message: + description: Human-readable description of the reason for the error + type: string + + DCAEDeploymentsListResponse: + description: | + Object providing a list of deployments + type: object + required: [requestId, deployments] + + properties: + requestId: + type: string + description: | + Unique identifier for the request + deployments: + type: array + items: + type: object + properties: + href: + type: string + description: | + URL for the service deployment + + DCAEPolicyBody: + description: policy_body - the whole object received from policy-engine + type: object + required: + - policyName + - policyVersion + - config + properties: + policyName: + description: unique policy name that contains the version and extension + type: string + policyVersion: + description: stringified int that is autoincremented by policy-engine + type: string + config: + description: the policy-config - the config data provided by policy owner + type: object + + DCAEPolicy: + description: policy object + type: object + required: + - policy_id + - policy_body + properties: + policy_id: + description: unique identifier of policy regardless of its version + type: string + policy_body: + $ref: "#/definitions/DCAEPolicyBody" + + DCAEPolicyRequest: + description: request to update policies on DCAE components. + type: object + required: + - latest_policies + + properties: + latest_policies: + description: "dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values" + type: object + additionalProperties: + $ref: "#/definitions/DCAEPolicy" diff --git a/docs/sections/apis/deploymenthandler.rst b/docs/sections/apis/deploymenthandler.rst new file mode 100644 index 00000000..3b25f1ea --- /dev/null +++ b/docs/sections/apis/deploymenthandler.rst @@ -0,0 +1,1041 @@ +deployment-handler API 4.1.0 +============================ + +.. toctree:: + :maxdepth: 3 + + +Description +~~~~~~~~~~~ + +High-level API for deploying/undeploying composed DCAE services using Cloudify Manager. + + + + + +License +~~~~~~~ + + +`Apache 2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_ + + + + +DCAE-DEPLOYMENTS +~~~~~~~~~~~~~~~~ + + +operations on dcae-deployments + + + + + +DELETE ``/dcae-deployments/{deploymentId}`` +------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Uninstall the DCAE service and remove all associated data from the orchestrator. + + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + deploymentId | path | Yes | string | | | Deployment identifier for the service to be uninstalled. + + +Request ++++++++ + + +Responses ++++++++++ + +**202** +^^^^^^^ + +Success: The dispatcher has initiated the uninstall operation. + + + +Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` + +**Example:** + +.. code-block:: javascript + + { + "links": { + "self": "somestring", + "status": "somestring" + }, + "requestId": "somestring" + } + +**400** +^^^^^^^ + +Bad request: See the message in the response for details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**500** +^^^^^^^ + +Problem on the server side. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**502** +^^^^^^^ + +Error reported to the dispatcher by a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**504** +^^^^^^^ + +Error communicating with a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + + + + + +GET ``/dcae-deployments`` +------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + List service deployments known to the orchestrator, optionally restricted to a single service type + + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + serviceTypeId | query | No | string | | | Service type identifier for the type whose deployments are to be listed + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Success. (Note that if no matching deployments are found, the request is still a success; the +deployments array is empty in that case.) + + + +Type: :ref:`DCAEDeploymentsListResponse <d_c51e57d9583f6119caf83dd017cf214c>` + +**Example:** + +.. code-block:: javascript + + { + "deployments": [ + { + "href": "somestring" + }, + { + "href": "somestring" + } + ], + "requestId": "somestring" + } + +**500** +^^^^^^^ + +Problem on the server side. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**502** +^^^^^^^ + +Error reported to the dispatcher by a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**504** +^^^^^^^ + +Error communicating with a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + + + + + +GET ``/dcae-deployments/{deploymentId}/operation/{operationId}`` +---------------------------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get status of a deployment operation + + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + deploymentId | path | Yes | string | | | + operationId | path | Yes | string | | | + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Status information retrieved successfully + + +Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>` + +**Example:** + +.. code-block:: javascript + + { + "error": "somestring", + "links": { + "self": "somestring", + "uninstall": "somestring" + }, + "operationType": "somestring", + "requestId": "somestring", + "status": "somestring" + } + +**404** +^^^^^^^ + +The operation information does not exist (possibly because the service has been uninstalled and deleted). + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**500** +^^^^^^^ + +Problem on the server side. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**502** +^^^^^^^ + +Error reported to the dispatcher by a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**504** +^^^^^^^ + +Error communicating with a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + + + + + +PUT ``/dcae-deployments/{deploymentId}`` +---------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Request deployment of a DCAE service + + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + deploymentId | path | Yes | string | | | Unique deployment identifier assigned by the API client. + + +Request ++++++++ + + + +.. _d_eea14e4929853a5aa415f44cd4868302: + +Body +^^^^ + +Request for deploying a DCAE service. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + inputs | No | :ref:`inputs <i_51dfb5d178ebacb6d6617c15cefffa86>` | | | Object containing inputs needed by the service blueprint to create an instance of the service. +Content of the object depends on the service being deployed. + + serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. + + +.. _i_51dfb5d178ebacb6d6617c15cefffa86: + +**Inputs schema:** + + +Object containing inputs needed by the service blueprint to create an instance of the service. +Content of the object depends on the service being deployed. + + + + +.. code-block:: javascript + + { + "inputs": {}, + "serviceTypeId": "somestring" + } + +Responses ++++++++++ + +**202** +^^^^^^^ + +Success: The content that was posted is valid, the dispatcher has + found the needed blueprint, created an instance of the topology in the orchestrator, + and started an installation workflow. + + + +Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` + +**Example:** + +.. code-block:: javascript + + { + "links": { + "self": "somestring", + "status": "somestring" + }, + "requestId": "somestring" + } + +**400** +^^^^^^^ + +Bad request: See the message in the response for details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**409** +^^^^^^^ + +A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**415** +^^^^^^^ + +Bad request: The Content-Type header does not indicate that the content is +'application/json' + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**500** +^^^^^^^ + +Problem on the server side. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**502** +^^^^^^^ + +Error reported to the dispatcher by a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + +**504** +^^^^^^^ + +Error communicating with a downstream system. See the message +in the response for more details. + + + +Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` + +**Example:** + +.. code-block:: javascript + + { + "message": "somestring", + "status": 1 + } + + + + +INFO +~~~~ + + +version and links + + + + + +GET ``/`` +--------- + + + +Description ++++++++++++ + +.. raw:: html + + Returns version information and links to API operations + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Success + + +Type: :ref:`DispatcherInfo <d_01a325801d3165f9b15dbdaa15b94815>` + +**Example:** + +.. code-block:: javascript + + { + "apiVersion": "somestring", + "links": { + "events": "somestring", + "info": "somestring" + }, + "serverVersion": "somestring" + } + + + + +POLICY +~~~~~~ + + +policy update API consumed by policy-handler and debug API to find policies on components + + + + + +GET ``/policy/components`` +-------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + debug API to find policies on components + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +deployment-handler found components with or without policies in cloudify + + + + + + +POST ``/policy`` +---------------- + + + +Description ++++++++++++ + +.. raw:: html + + policy update API consumed by policy-handler + + +Request ++++++++ + + + +.. _d_6ea6e6f48a0302e963a67833bbd0ff4a: + +Body +^^^^ + +request to update policies on DCAE components. + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + latest_policies | Yes | :ref:`latest_policies <i_22fec92398d6fc407cf75f0b4c0f3614>` | | | dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + +.. _i_22fec92398d6fc407cf75f0b4c0f3614: + +**Latest_policies schema:** + + +dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + +Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} + + + +.. code-block:: javascript + + { + "latest_policies": { + "DCAEPolicy": { + "policy_body": { + "config": {}, + "policyName": "somestring", + "policyVersion": "somestring" + }, + "policy_id": "somestring" + } + } + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +deployment-handler always responds with ok to /policy before processing the request + + + + + +Data Structures +~~~~~~~~~~~~~~~ + +.. _d_eea14e4929853a5aa415f44cd4868302: + +DCAEDeploymentRequest Model Structure +------------------------------------- + +Request for deploying a DCAE service. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + inputs | No | :ref:`inputs <i_51dfb5d178ebacb6d6617c15cefffa86>` | | | Object containing inputs needed by the service blueprint to create an instance of the service. +Content of the object depends on the service being deployed. + + serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. + + +.. _i_51dfb5d178ebacb6d6617c15cefffa86: + +**Inputs schema:** + + +Object containing inputs needed by the service blueprint to create an instance of the service. +Content of the object depends on the service being deployed. + + + + +.. _d_6157bd3de5c8c7de78f2ab86397667e0: + +DCAEDeploymentResponse Model Structure +-------------------------------------- + +Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + links | No | :ref:`DCAEDeploymentResponse_links <d_e5951c399cff33430222aefe098fbbbb>` | | | + requestId | Yes | string | | | Unique identifier for the request + + +.. _d_e5951c399cff33430222aefe098fbbbb: + +DCAEDeploymentResponse_links Model Structure +-------------------------------------------- + +Links that the API client can access. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + self | No | string | | | Link used to retrieve information about the service being deployed + + status | No | string | | | Link used to retrieve information about the status of the installation workflow + +.. _d_c51e57d9583f6119caf83dd017cf214c: + +DCAEDeploymentsListResponse Model Structure +------------------------------------------- + +Object providing a list of deployments + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + deployments | Yes | array of :ref:`DCAEDeploymentsListResponse_deployments <d_bf53389ec58f942852b6e44f2f35173c>` | | | + requestId | Yes | string | | | Unique identifier for the request + + +.. _d_bf53389ec58f942852b6e44f2f35173c: + +DCAEDeploymentsListResponse_deployments Model Structure +------------------------------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + href | No | string | | | URL for the service deployment + + +.. _d_74f3f4f847dfb6bd181fcae06ad880b4: + +DCAEErrorResponse Model Structure +--------------------------------- + +Object reporting an error. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + message | No | string | | | Human-readable description of the reason for the error + status | Yes | integer | | | HTTP status code for the response + +.. _d_f0103f05736b04468a4f85fe90da2e16: + +DCAEOperationStatusResponse Model Structure +------------------------------------------- + +Response body for a request for status of an installation or uninstallation operation. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + error | No | string | | | If status is 'failed', this field will be present and contain additional information about the reason the operation failed. + + links | No | :ref:`DCAEOperationStatusResponse_links <d_d0c8dc90669705fbfd08cca966a5fcae>` | | | + operationType | Yes | string | | | Type of operation being reported on. ('install' or 'uninstall') + + requestId | Yes | string | | | A unique identifier assigned to the request. Useful for tracing a request through logs. + + status | Yes | string | | | Status of the installation or uninstallation operation. Possible values are 'processing', +'succeeded', and 'failed' + + +.. _d_d0c8dc90669705fbfd08cca966a5fcae: + +DCAEOperationStatusResponse_links Model Structure +------------------------------------------------- + +If the operation succeeded, links that the client can follow to take further action. Note that a successful 'uninstall' operation removes the DCAE service instance completely, so there are no possible further actions, and no links. + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + self | No | string | | | Link used to retrieve information about the service. + + uninstall | No | string | | | Link used to trigger an 'uninstall' operation for the service. (Use the DELETE method.) + +.. _d_1e3e880a733b457b648bd8c99e6c859c: + +DCAEPolicy Model Structure +-------------------------- + +policy object + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | | + policy_id | Yes | string | | | unique identifier of policy regardless of its version + +.. _d_7ffe00ee1aaae6811199d64ff3fea344: + +DCAEPolicyBody Model Structure +------------------------------ + +policy_body - the whole object received from policy-engine + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + config | Yes | :ref:`config <i_4926bbee050a2d1f47c3281f6c9095cf>` | | | the policy-config - the config data provided by policy owner + policyName | Yes | string | | | unique policy name that contains the version and extension + policyVersion | Yes | string | | | stringified int that is autoincremented by policy-engine + +.. _i_4926bbee050a2d1f47c3281f6c9095cf: + +**Config schema:** + + +the policy-config - the config data provided by policy owner + + + +.. _d_6ea6e6f48a0302e963a67833bbd0ff4a: + +DCAEPolicyRequest Model Structure +--------------------------------- + +request to update policies on DCAE components. + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + latest_policies | Yes | :ref:`latest_policies <i_22fec92398d6fc407cf75f0b4c0f3614>` | | | dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + +.. _i_22fec92398d6fc407cf75f0b4c0f3614: + +**Latest_policies schema:** + + +dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + +Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} + + + +.. _d_01a325801d3165f9b15dbdaa15b94815: + +DispatcherInfo Model Structure +------------------------------ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + apiVersion | No | string | | | version of API supported by this server + + links | No | :ref:`DispatcherInfo_links <d_0a18e12425d91480a8516b17efe05340>` | | | + serverVersion | No | string | | | version of software running on this server + + +.. _d_0a18e12425d91480a8516b17efe05340: + +DispatcherInfo_links Model Structure +------------------------------------ + +Links to API resources + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + events | No | string | | | path for the events endpoint + + info | No | string | | | path for the server information endpoint + + diff --git a/docs/sections/apis/inventory_api.rst b/docs/sections/apis/inventory_api.rst new file mode 100644 index 00000000..1dd3a297 --- /dev/null +++ b/docs/sections/apis/inventory_api.rst @@ -0,0 +1,1642 @@ +DCAE Inventory API 2.1.0 +======================== + +.. toctree:: + :maxdepth: 3 + + +Description +~~~~~~~~~~~ + +DCAE Inventory is a web service that provides the following: + +1. Real-time data on all DCAE services and their components +2. Comprehensive details on available DCAE service types + + + + +Contact Information +~~~~~~~~~~~~~~~~~~~ + + + +dcae@lists.openecomp.org + + + + + + +DEFAULT +~~~~~~~ + + + + +GET ``/dcae-service-types`` +--------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get a list of `DCAEServiceType` objects. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + typeName | query | No | string | | | Filter by service type name + onlyLatest | query | No | boolean | | {"default": true} | If set to true, query returns just the latest versions of DCAE service types. If set to false, then all versions are returned. Default is true + onlyActive | query | No | boolean | | {"default": true} | If set to true, query returns only *active* DCAE service types. If set to false, then all DCAE service types are returned. Default is true + vnfType | query | No | string | | | Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive. + serviceId | query | No | string | | | Filter by assocaited service id. Instances with service id null or empty is always returned. + serviceLocation | query | No | string | | | Filter by associated service location. Instances with service location null or empty is always returned. + asdcServiceId | query | No | string | | | Filter by associated asdc design service id. Setting this to `NONE` will return instances that have asdc service id set to null + asdcResourceId | query | No | string | | | Filter by associated asdc design resource id. Setting this to `NONE` will return instances that have asdc resource id set to null + offset | query | No | integer | int32 | | Query resultset offset used for pagination (zero-based) + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +List of `DCAEServiceType` objects + + +Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>` + +**Example:** + +.. code-block:: javascript + + { + "items": [ + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + }, + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + } + ], + "links": { + "nextLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "previousLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + } + }, + "totalCount": 1 + } + + + + + +DELETE ``/dcae-service-types/{typeId}`` +--------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Deactivates existing `DCAEServiceType` instances + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + typeId | path | Yes | string | | | + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +`DCAEServiceType` has been deactivated + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**404** +^^^^^^^ + +`DCAEServiceType` not found + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**410** +^^^^^^^ + +`DCAEServiceType` already gone + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + + +GET ``/dcae-service-types/{typeId}`` +------------------------------------ + + + +Description ++++++++++++ + +.. raw:: html + + Get a `DCAEServiceType` object. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + typeId | path | Yes | string | | | + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Single `DCAEServiceType` object + + +Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` + +**Example:** + +.. code-block:: javascript + + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + } + +**404** +^^^^^^^ + +Resource not found + + +Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` + +**Example:** + +.. code-block:: javascript + + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + } + + + + + +POST ``/dcae-service-types`` +---------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Inserts a new `DCAEServiceType` or updates an existing instance. Updates are only allowed iff there are no running DCAE services of the requested type, + + +Request ++++++++ + + + +.. _d_57dc24aa38507ded2f27eec90206336e: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. + asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. + asdcServiceURL | No | string | | | URL to the ASDC service model + blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables + owner | Yes | string | | | + serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. + serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. + typeName | Yes | string | | | Descriptive name for this DCAE service type + typeVersion | Yes | integer | int32 | | Version number for this DCAE service type + vnfTypes | No | array of string | | | + +.. code-block:: javascript + + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "owner": "somestring", + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +Single `DCAEServiceType` object. + + +Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` + +**Example:** + +.. code-block:: javascript + + { + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceIds": [ + "somestring", + "somestring" + ], + "serviceLocations": [ + "somestring", + "somestring" + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, + "vnfTypes": [ + "somestring", + "somestring" + ] + } + +**400** +^^^^^^^ + +Bad request provided. + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**409** +^^^^^^^ + +Failed to update because there are still DCAE services of the requested type running. + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + + +GET ``/dcae-services`` +---------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get a list of `DCAEService` objects. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + typeId | query | No | string | | | DCAE service type name + vnfId | query | No | string | | | + vnfType | query | No | string | | | Filter by associated vnf type. This field is treated case insensitive. + vnfLocation | query | No | string | | | + componentType | query | No | string | | | Use to filter by a specific DCAE service component type + shareable | query | No | boolean | | | Use to filter by DCAE services that have shareable components or not + created | query | No | string | | | Use to filter by created time + offset | query | No | integer | int32 | | Query resultset offset used for pagination (zero-based) + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +List of `DCAEService` objects + + +Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>` + +**Example:** + +.. code-block:: javascript + + { + "items": [ + { + "components": [ + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + }, + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + } + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceId": "somestring", + "typeLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfId": "somestring", + "vnfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfLocation": "somestring", + "vnfType": "somestring" + }, + { + "components": [ + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + }, + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + } + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceId": "somestring", + "typeLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfId": "somestring", + "vnfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfLocation": "somestring", + "vnfType": "somestring" + } + ], + "links": { + "nextLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "previousLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + } + }, + "totalCount": 1 + } + +**502** +^^^^^^^ + +Bad response from DCAE controller + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**504** +^^^^^^^ + +Failed to connect with DCAE controller + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + + +GET ``/dcae-services-groupby/{propertyName}`` +--------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get a list of unique values for the given `propertyName` + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + propertyName | path | Yes | string | | | Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation` + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +List of unique property values + + +Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>` + +**Example:** + +.. code-block:: javascript + + { + "propertyName": "somestring", + "propertyValues": [ + { + "count": 1, + "dcaeServiceQueryLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "propertyValue": "somestring" + }, + { + "count": 1, + "dcaeServiceQueryLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "propertyValue": "somestring" + } + ] + } + + + + + +DELETE ``/dcae-services/{serviceId}`` +------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Remove an existing `DCAEService` object. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + serviceId | path | Yes | string | | | + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +DCAE service has been removed + + +**404** +^^^^^^^ + +Unknown DCAE service + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + + +GET ``/dcae-services/{serviceId}`` +---------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Get a `DCAEService` object. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + serviceId | path | Yes | string | | | + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Single `DCAEService` object + + +Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` + +**Example:** + +.. code-block:: javascript + + { + "components": [ + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + }, + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + } + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceId": "somestring", + "typeLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfId": "somestring", + "vnfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfLocation": "somestring", + "vnfType": "somestring" + } + +**404** +^^^^^^^ + +DCAE service not found + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**502** +^^^^^^^ + +Bad response from DCAE controller + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**504** +^^^^^^^ + +Failed to connect with DCAE controller + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + + +PUT ``/dcae-services/{serviceId}`` +---------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Put a new or update an existing `DCAEService` object. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + serviceId | path | Yes | string | | | + + +Request ++++++++ + + + +.. _d_81c18e0dd7a3af8fb1ba658e72907e7b: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` | | | List of DCAE service components that this service is composed of + deploymentRef | No | string | | | Reference to a Cloudify deployment + typeId | Yes | string | | | Id of the associated DCAE service type + vnfId | Yes | string | | | Id of the associated VNF that this service is monitoring + vnfLocation | Yes | string | | | Location identifier of the associated VNF that this service is monitoring + vnfType | Yes | string | | | The type of the associated VNF that this service is monitoring + +.. code-block:: javascript + + { + "components": [ + { + "componentId": "somestring", + "componentSource": "DCAEController", + "componentType": "somestring", + "shareable": 1 + }, + { + "componentId": "somestring", + "componentSource": "DCAEController", + "componentType": "somestring", + "shareable": 1 + } + ], + "deploymentRef": "somestring", + "typeId": "somestring", + "vnfId": "somestring", + "vnfLocation": "somestring", + "vnfType": "somestring" + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +Single `DCAEService` object + + +Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` + +**Example:** + +.. code-block:: javascript + + { + "components": [ + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + }, + { + "componentId": "somestring", + "componentLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, + "status": "somestring" + } + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "selfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "serviceId": "somestring", + "typeLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfId": "somestring", + "vnfLink": { + "params": {}, + "rel": "somestring", + "rels": [ + "somestring", + "somestring" + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", + "uriBuilder": {} + }, + "vnfLocation": "somestring", + "vnfType": "somestring" + } + +**422** +^^^^^^^ + +Bad request provided + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + + +Data Structures +~~~~~~~~~~~~~~~ + +.. _d_8a94f348f7df00259702f8d9b7d2ea84: + +ApiResponseMessage Model Structure +---------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + code | No | integer | int32 | | + message | No | string | | | + type | No | string | | | + +.. _d_ae85cd292c2b4046e1ea1bbb02c7ea63: + +DCAEService Model Structure +--------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + components | No | array of :ref:`DCAEServiceComponent <d_51674dafcc623be79f21ecea545c345d>` | | | + created | No | string | date-time | | + deploymentRef | No | string | | | Reference to a Cloudify deployment + modified | No | string | date-time | | + selfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is serviceId + serviceId | No | string | | | + typeLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is typeId + vnfId | No | string | | | + vnfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is vnfId + vnfLocation | No | string | | | Location information of the associated VNF + vnfType | No | string | | | + +.. _d_51674dafcc623be79f21ecea545c345d: + +DCAEServiceComponent Model Structure +------------------------------------ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + componentId | Yes | string | | | The id format is unique to the source + componentLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link to the underlying resource of this component + componentSource | Yes | string | | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components + componentType | Yes | string | | | + created | Yes | string | date-time | | + location | No | string | | | Location information of the component + modified | Yes | string | date-time | | + shareable | Yes | integer | int32 | | Used to determine if this component can be shared amongst different DCAE services + status | No | string | | | + +.. _d_55af22c43245c290d643f75be1f4f254: + +DCAEServiceComponentRequest Model Structure +------------------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + componentId | Yes | string | | | The id format is unique to the source + componentSource | Yes | string | | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components + componentType | Yes | string | | | + shareable | Yes | integer | int32 | | Used to determine if this component can be shared amongst different DCAE services + +.. _d_a6dc4f986873bc126fc916189ffa5e91: + +DCAEServiceGroupByResults Model Structure +----------------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + propertyName | No | string | | | Property name of DCAE service that the group by operation was performed on + propertyValues | No | array of :ref:`DCAEServiceGroupByResultsPropertyValues <d_0119caa52e274e5e2311b367df38d686>` | | | + +.. _d_0119caa52e274e5e2311b367df38d686: + +DCAEServiceGroupByResultsPropertyValues Model Structure +------------------------------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + count | No | integer | int32 | | + dcaeServiceQueryLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value. + propertyValue | No | string | | | + +.. _d_81c18e0dd7a3af8fb1ba658e72907e7b: + +DCAEServiceRequest Model Structure +---------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` | | | List of DCAE service components that this service is composed of + deploymentRef | No | string | | | Reference to a Cloudify deployment + typeId | Yes | string | | | Id of the associated DCAE service type + vnfId | Yes | string | | | Id of the associated VNF that this service is monitoring + vnfLocation | Yes | string | | | Location identifier of the associated VNF that this service is monitoring + vnfType | Yes | string | | | The type of the associated VNF that this service is monitoring + +.. _d_b0cb5f12dbde8c0c42487c089983687e: + +DCAEServiceType Model Structure +------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. + asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. + asdcServiceURL | No | string | | | URL to the ASDC service model + blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables + created | Yes | string | date-time | | Created timestamp for this DCAE service type in epoch time + deactivated | No | string | date-time | | Deactivated timestamp for this DCAE service type in epoch time + owner | Yes | string | | | + selfLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link to self where the Link.title is typeName + serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. + serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. + typeId | Yes | string | | | Unique identifier for this DCAE service type + typeName | Yes | string | | | Descriptive name for this DCAE service type + typeVersion | Yes | integer | int32 | | Version number for this DCAE service type + vnfTypes | No | array of string | | | + +.. _d_57dc24aa38507ded2f27eec90206336e: + +DCAEServiceTypeRequest Model Structure +-------------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. + asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. + asdcServiceURL | No | string | | | URL to the ASDC service model + blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables + owner | Yes | string | | | + serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. + serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. + typeName | Yes | string | | | Descriptive name for this DCAE service type + typeVersion | Yes | integer | int32 | | Version number for this DCAE service type + vnfTypes | No | array of string | | | + +.. _d_b1ccd4187d31690b8e704c0aa01b2c59: + +InlineResponse200 Model Structure +--------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + items | No | array of :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` | | | + links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | + totalCount | No | integer | int32 | | + +.. _d_31bb361a8900a0bed20df49b94f1e33b: + +InlineResponse2001 Model Structure +---------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + items | No | array of :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` | | | + links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | + totalCount | No | integer | int32 | | + +.. _d_e52a59e574408d4d622b3f1f61619b1c: + +InlineResponse200Links Model Structure +-------------------------------------- + +Pagination links + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + nextLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | + previousLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | + +.. _d_add3c3fd2e145f9e5a78be6e7b208ebb: + +Link Model Structure +-------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + params | No | :ref:`params <i_adf17ca32891d8ece6efd40541d227f2>` | | | + rel | No | string | | | + rels | No | array of string | | | + title | No | string | | | + type | No | string | | | + uri | No | string | uri | | + uriBuilder | No | :ref:`UriBuilder <d_a7b6b5c694147ea9dcfb5a5a6cbef017>` | | | + +.. _i_adf17ca32891d8ece6efd40541d227f2: + +**Params schema:** + + +Map of {"key":"string"} + +.. _d_a7b6b5c694147ea9dcfb5a5a6cbef017: + +UriBuilder Model Structure +-------------------------- + + + diff --git a/docs/sections/apis/inventory_api.yaml b/docs/sections/apis/inventory_api.yaml new file mode 100644 index 00000000..11dbcbc5 --- /dev/null +++ b/docs/sections/apis/inventory_api.yaml @@ -0,0 +1,680 @@ +swagger: '2.0' +info: + version: "2.1.0" + title: DCAE Inventory API + description: | + DCAE Inventory is a web service that provides the following: + + 1. Real-time data on all DCAE services and their components + 2. Comprehensive details on available DCAE service types + contact: + email: dcae@lists.openecomp.org +externalDocs: + description: DCAE Inventory + url: https://gerrit.onap.org/r/#/admin/projects/dcae/dcae-inventory +paths: + /dcae-service-types: + get: + summary: "" + description: "Get a list of `DCAEServiceType` objects." + operationId: "dcaeServiceTypesGet" + consumes: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "typeName" + in: "query" + description: "Filter by service type name" + required: false + type: "string" + - name: "onlyLatest" + in: "query" + description: "If set to true, query returns just the latest versions of DCAE\ + \ service types. If set to false, then all versions are returned. Default\ + \ is true" + required: false + type: "boolean" + default: true + - name: "onlyActive" + in: "query" + description: "If set to true, query returns only *active* DCAE service types.\ + \ If set to false, then all DCAE service types are returned. Default is\ + \ true" + required: false + type: "boolean" + default: true + - name: "vnfType" + in: "query" + description: "Filter by associated vnf type. No wildcards, matches are explicit.\ + \ This field is treated case insensitive." + required: false + type: "string" + - name: "serviceId" + in: "query" + description: "Filter by assocaited service id. Instances with service id null\ + \ or empty is always returned." + required: false + type: "string" + - name: "serviceLocation" + in: "query" + description: "Filter by associated service location. Instances with service\ + \ location null or empty is always returned." + required: false + type: "string" + - name: "asdcServiceId" + in: "query" + description: "Filter by associated asdc design service id. Setting this to\ + \ `NONE` will return instances that have asdc service id set to null" + required: false + type: "string" + - name: "asdcResourceId" + in: "query" + description: "Filter by associated asdc design resource id. Setting this to\ + \ `NONE` will return instances that have asdc resource id set to null" + required: false + type: "string" + - name: "offset" + in: "query" + description: "Query resultset offset used for pagination (zero-based)" + required: false + type: "integer" + format: "int32" + responses: + 200: + description: "List of `DCAEServiceType` objects" + schema: + $ref: "#/definitions/InlineResponse200" + post: + summary: "" + description: "Inserts a new `DCAEServiceType` or updates an existing instance.\ + \ Updates are only allowed iff there are no running DCAE services of the requested\ + \ type," + operationId: "dcaeServiceTypesTypeNamePut" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/DCAEServiceTypeRequest" + responses: + 200: + description: "Single `DCAEServiceType` object." + schema: + $ref: "#/definitions/DCAEServiceType" + 400: + description: "Bad request provided." + schema: + $ref: "#/definitions/ApiResponseMessage" + 409: + description: "Failed to update because there are still DCAE services of\ + \ the requested type running." + schema: + $ref: "#/definitions/ApiResponseMessage" + /dcae-service-types/{typeId}: + get: + summary: "" + description: "Get a `DCAEServiceType` object." + operationId: "dcaeServiceTypesTypeIdGet" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "typeId" + in: "path" + required: true + type: "string" + responses: + 200: + description: "Single `DCAEServiceType` object" + schema: + $ref: "#/definitions/DCAEServiceType" + 404: + description: "Resource not found" + schema: + $ref: "#/definitions/DCAEServiceType" + delete: + summary: "" + description: "Deactivates existing `DCAEServiceType` instances" + operationId: "dcaeServiceTypesTypeIdDelete" + consumes: + - "application/vnd.dcae.inventory.v1+json" + - "application/json" + produces: + - "application/vnd.dcae.inventory.v1+json" + - "application/json" + parameters: + - name: "typeId" + in: "path" + required: true + type: "string" + responses: + 200: + description: "`DCAEServiceType` has been deactivated" + schema: + $ref: "#/definitions/ApiResponseMessage" + 410: + description: "`DCAEServiceType` already gone" + schema: + $ref: "#/definitions/ApiResponseMessage" + 404: + description: "`DCAEServiceType` not found" + schema: + $ref: "#/definitions/ApiResponseMessage" + /dcae-services: + get: + summary: "" + description: "Get a list of `DCAEService` objects." + operationId: "dcaeServicesGet" + consumes: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "typeId" + in: "query" + description: "DCAE service type name" + required: false + type: "string" + - name: "vnfId" + in: "query" + required: false + type: "string" + - name: "vnfType" + in: "query" + description: "Filter by associated vnf type. This field is treated case insensitive." + required: false + type: "string" + - name: "vnfLocation" + in: "query" + required: false + type: "string" + - name: "componentType" + in: "query" + description: "Use to filter by a specific DCAE service component type" + required: false + type: "string" + - name: "shareable" + in: "query" + description: "Use to filter by DCAE services that have shareable components\ + \ or not" + required: false + type: "boolean" + - name: "created" + in: "query" + description: "Use to filter by created time" + required: false + type: "string" + - name: "offset" + in: "query" + description: "Query resultset offset used for pagination (zero-based)" + required: false + type: "integer" + format: "int32" + responses: + 200: + description: "List of `DCAEService` objects" + schema: + $ref: "#/definitions/InlineResponse2001" + 502: + description: "Bad response from DCAE controller" + schema: + $ref: "#/definitions/ApiResponseMessage" + 504: + description: "Failed to connect with DCAE controller" + schema: + $ref: "#/definitions/ApiResponseMessage" + /dcae-services-groupby/{propertyName}: + get: + summary: "" + description: "Get a list of unique values for the given `propertyName`" + operationId: "dcaeServicesGroupbyPropertyNameGet" + consumes: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "propertyName" + in: "path" + description: "Property to find unique values. Restricted to `type`, `vnfType`,\ + \ `vnfLocation`" + required: true + type: "string" + responses: + 200: + description: "List of unique property values" + schema: + $ref: "#/definitions/DCAEServiceGroupByResults" + /dcae-services/{serviceId}: + get: + summary: "" + description: "Get a `DCAEService` object." + operationId: "dcaeServicesServiceIdGet" + consumes: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "serviceId" + in: "path" + required: true + type: "string" + responses: + 200: + description: "Single `DCAEService` object" + schema: + $ref: "#/definitions/DCAEService" + 502: + description: "Bad response from DCAE controller" + schema: + $ref: "#/definitions/ApiResponseMessage" + 404: + description: "DCAE service not found" + schema: + $ref: "#/definitions/ApiResponseMessage" + 504: + description: "Failed to connect with DCAE controller" + schema: + $ref: "#/definitions/ApiResponseMessage" + put: + summary: "" + description: "Put a new or update an existing `DCAEService` object." + operationId: "dcaeServicesServiceIdPut" + consumes: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "serviceId" + in: "path" + required: true + type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/DCAEServiceRequest" + responses: + 200: + description: "Single `DCAEService` object" + schema: + $ref: "#/definitions/DCAEService" + 422: + description: "Bad request provided" + schema: + $ref: "#/definitions/ApiResponseMessage" + delete: + summary: "" + description: "Remove an existing `DCAEService` object." + operationId: "dcaeServicesServiceIdDelete" + consumes: + - "application/vnd.dcae.inventory.v1+json" + - "application/json" + produces: + - "application/json" + - "application/vnd.dcae.inventory.v1+json" + parameters: + - name: "serviceId" + in: "path" + required: true + type: "string" + responses: + 200: + description: "DCAE service has been removed" + 404: + description: "Unknown DCAE service" + schema: + $ref: "#/definitions/ApiResponseMessage" +definitions: + DCAEServiceTypeRequest: + type: "object" + required: + - "blueprintTemplate" + - "owner" + - "typeName" + - "typeVersion" + properties: + owner: + type: "string" + typeName: + type: "string" + description: "Descriptive name for this DCAE service type" + typeVersion: + type: "integer" + format: "int32" + description: "Version number for this DCAE service type" + blueprintTemplate: + type: "string" + description: "String representation of a Cloudify blueprint with unbound variables" + serviceIds: + type: "array" + description: "List of service ids that are used to associate with DCAE service\ + \ type. DCAE service types with this propery as null or empty means them\ + \ apply for every service id." + items: + type: "string" + vnfTypes: + type: "array" + items: + type: "string" + serviceLocations: + type: "array" + description: "List of service locations that are used to associate with DCAE\ + \ service type. DCAE service types with this propery as null or empty means\ + \ them apply for every service location." + items: + type: "string" + asdcServiceId: + type: "string" + description: "Id of service this DCAE service type is associated with. Value\ + \ source is from ASDC's notification event's field `serviceInvariantUUID`." + asdcResourceId: + type: "string" + description: "Id of vf/vnf instance this DCAE service type is associated with.\ + \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." + asdcServiceURL: + type: "string" + description: "URL to the ASDC service model" + DCAEServiceComponentRequest: + type: "object" + required: + - "componentId" + - "componentSource" + - "componentType" + - "shareable" + properties: + componentId: + type: "string" + description: "The id format is unique to the source" + componentType: + type: "string" + componentSource: + type: "string" + description: "Specifies the name of the underying source service that is responsible\ + \ for this components" + enum: + - "DCAEController" + - "DMaaPController" + shareable: + type: "integer" + format: "int32" + description: "Used to determine if this component can be shared amongst different\ + \ DCAE services" + DCAEServiceGroupByResultsPropertyValues: + type: "object" + properties: + count: + type: "integer" + format: "int32" + propertyValue: + type: "string" + dcaeServiceQueryLink: + description: "Link.title is the DCAE service property value. Following this\ + \ link will provide a list of DCAE services that all have this property\ + \ value." + $ref: "#/definitions/Link" + DCAEServiceGroupByResults: + type: "object" + properties: + propertyName: + type: "string" + description: "Property name of DCAE service that the group by operation was\ + \ performed on" + propertyValues: + type: "array" + items: + $ref: "#/definitions/DCAEServiceGroupByResultsPropertyValues" + InlineResponse200: + type: "object" + properties: + links: + $ref: "#/definitions/InlineResponse200Links" + totalCount: + type: "integer" + format: "int32" + items: + type: "array" + items: + $ref: "#/definitions/DCAEServiceType" + DCAEServiceRequest: + type: "object" + required: + - "components" + - "typeId" + - "vnfId" + - "vnfLocation" + - "vnfType" + properties: + typeId: + type: "string" + description: "Id of the associated DCAE service type" + vnfId: + type: "string" + description: "Id of the associated VNF that this service is monitoring" + vnfType: + type: "string" + description: "The type of the associated VNF that this service is monitoring" + vnfLocation: + type: "string" + description: "Location identifier of the associated VNF that this service\ + \ is monitoring" + deploymentRef: + type: "string" + description: "Reference to a Cloudify deployment" + components: + type: "array" + description: "List of DCAE service components that this service is composed\ + \ of" + items: + $ref: "#/definitions/DCAEServiceComponentRequest" + InlineResponse200Links: + type: "object" + properties: + previousLink: + $ref: "#/definitions/Link" + nextLink: + $ref: "#/definitions/Link" + description: "Pagination links" + ApiResponseMessage: + type: "object" + properties: + code: + type: "integer" + format: "int32" + type: + type: "string" + message: + type: "string" + DCAEService: + type: "object" + properties: + serviceId: + type: "string" + selfLink: + description: "Link.title is serviceId" + $ref: "#/definitions/Link" + created: + type: "string" + format: "date-time" + modified: + type: "string" + format: "date-time" + typeLink: + description: "Link.title is typeId" + $ref: "#/definitions/Link" + vnfId: + type: "string" + vnfLink: + description: "Link.title is vnfId" + $ref: "#/definitions/Link" + vnfType: + type: "string" + vnfLocation: + type: "string" + description: "Location information of the associated VNF" + deploymentRef: + type: "string" + description: "Reference to a Cloudify deployment" + components: + type: "array" + items: + $ref: "#/definitions/DCAEServiceComponent" + InlineResponse2001: + type: "object" + properties: + links: + $ref: "#/definitions/InlineResponse200Links" + totalCount: + type: "integer" + format: "int32" + items: + type: "array" + items: + $ref: "#/definitions/DCAEService" + UriBuilder: + type: "object" + Link: + type: "object" + properties: + title: + type: "string" + rel: + type: "string" + uri: + type: "string" + format: "uri" + uriBuilder: + $ref: "#/definitions/UriBuilder" + rels: + type: "array" + items: + type: "string" + params: + type: "object" + additionalProperties: + type: "string" + type: + type: "string" + DCAEServiceComponent: + type: "object" + required: + - "componentId" + - "componentLink" + - "componentSource" + - "componentType" + - "created" + - "modified" + - "shareable" + properties: + componentId: + type: "string" + description: "The id format is unique to the source" + componentLink: + description: "Link to the underlying resource of this component" + $ref: "#/definitions/Link" + created: + type: "string" + format: "date-time" + modified: + type: "string" + format: "date-time" + componentType: + type: "string" + componentSource: + type: "string" + description: "Specifies the name of the underying source service that is responsible\ + \ for this components" + enum: + - "DCAEController" + - "DMaaPController" + status: + type: "string" + location: + type: "string" + description: "Location information of the component" + shareable: + type: "integer" + format: "int32" + description: "Used to determine if this component can be shared amongst different\ + \ DCAE services" + DCAEServiceType: + type: "object" + required: + - "blueprintTemplate" + - "created" + - "owner" + - "selfLink" + - "typeId" + - "typeName" + - "typeVersion" + properties: + owner: + type: "string" + typeName: + type: "string" + description: "Descriptive name for this DCAE service type" + typeVersion: + type: "integer" + format: "int32" + description: "Version number for this DCAE service type" + blueprintTemplate: + type: "string" + description: "String representation of a Cloudify blueprint with unbound variables" + serviceIds: + type: "array" + description: "List of service ids that are used to associate with DCAE service\ + \ type. DCAE service types with this propery as null or empty means them\ + \ apply for every service id." + items: + type: "string" + vnfTypes: + type: "array" + items: + type: "string" + serviceLocations: + type: "array" + description: "List of service locations that are used to associate with DCAE\ + \ service type. DCAE service types with this propery as null or empty means\ + \ them apply for every service location." + items: + type: "string" + asdcServiceId: + type: "string" + description: "Id of service this DCAE service type is associated with. Value\ + \ source is from ASDC's notification event's field `serviceInvariantUUID`." + asdcResourceId: + type: "string" + description: "Id of vf/vnf instance this DCAE service type is associated with.\ + \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." + asdcServiceURL: + type: "string" + description: "URL to the ASDC service model" + typeId: + type: "string" + description: "Unique identifier for this DCAE service type" + selfLink: + description: "Link to self where the Link.title is typeName" + $ref: "#/definitions/Link" + created: + type: "string" + format: "date-time" + description: "Created timestamp for this DCAE service type in epoch time" + deactivated: + type: "string" + format: "date-time" + description: "Deactivated timestamp for this DCAE service type in epoch time" diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst new file mode 100644 index 00000000..41d903be --- /dev/null +++ b/docs/sections/apis/ves.rst @@ -0,0 +1,2835 @@ +VES Collector 1.1.0 +=================== + +.. toctree:: + :maxdepth: 3 + + +Description +~~~~~~~~~~~ + +Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics + + + + +Contact Information +~~~~~~~~~~~~~~~~~~~ + + + +dcae@lists.openecomp.org + + + + + + +Security +~~~~~~~~ + + +.. _securities_basicAuth: + +basicAuth (HTTP Basic Authentication) +------------------------------------- + + +*HTTP Basic Authentication. Works over `HTTP` and `HTTPS`* + + + + + +DEFAULT +~~~~~~~ + + + + +GET ``/healthcheck`` +-------------------- + + + + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +healthcheck successful + + + + + + +POST ``/eventListener/v5`` +-------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + uri for posting VES event objects + + +Request ++++++++ + + + +.. _d_f598222d7a83ca9c3538556b263682d1: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + +.. code-block:: javascript + + { + "event": { + "commonEventHeader": { + "domain": "fault", + "eventId": "somestring", + "eventName": "somestring", + "eventType": "somestring", + "internalHeaderFields": {}, + "lastEpochMicrosec": 1, + "nfNamingCode": "somestring", + "nfcNamingCode": "somestring", + "priority": "High", + "reportingEntityId": "somestring", + "reportingEntityName": "somestring", + "sequence": 1, + "sourceId": "somestring", + "sourceName": "somestring", + "startEpochMicrosec": 1, + "version": 1 + }, + "faultFields": { + "alarmAdditionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "alarmCondition": "somestring", + "alarmInterfaceA": "somestring", + "eventCategory": "somestring", + "eventSeverity": "CRITICAL", + "eventSourceType": "somestring", + "faultFieldsVersion": 1, + "specificProblem": "somestring", + "vfStatus": "Active" + }, + "heartbeatFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "heartbeatFieldsVersion": 1, + "heartbeatInterval": 1 + }, + "measurementsForVfScalingFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "additionalMeasurements": [ + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + }, + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + } + ], + "additionalObjects": [ + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + }, + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + } + ], + "codecUsageArray": [ + { + "codecIdentifier": "somestring", + "numberInUse": 1 + }, + { + "codecIdentifier": "somestring", + "numberInUse": 1 + } + ], + "concurrentSessions": 1, + "configuredEntities": 1, + "cpuUsageArray": [ + { + "cpuIdentifier": "somestring", + "cpuIdle": 1, + "cpuUsageInterrupt": 1, + "cpuUsageNice": 1, + "cpuUsageSoftIrq": 1, + "cpuUsageSteal": 1, + "cpuUsageSystem": 1, + "cpuUsageUser": 1, + "cpuWait": 1, + "percentUsage": 1 + }, + { + "cpuIdentifier": "somestring", + "cpuIdle": 1, + "cpuUsageInterrupt": 1, + "cpuUsageNice": 1, + "cpuUsageSoftIrq": 1, + "cpuUsageSteal": 1, + "cpuUsageSystem": 1, + "cpuUsageUser": 1, + "cpuWait": 1, + "percentUsage": 1 + } + ], + "diskUsageArray": [ + { + "diskIdentifier": "somestring", + "diskIoTimeAvg": 1, + "diskIoTimeLast": 1, + "diskIoTimeMax": 1, + "diskIoTimeMin": 1, + "diskMergedReadAvg": 1, + "diskMergedReadLast": 1, + "diskMergedReadMax": 1, + "diskMergedReadMin": 1, + "diskMergedWriteAvg": 1, + "diskMergedWriteLast": 1, + "diskMergedWriteMax": 1, + "diskMergedWriteMin": 1, + "diskOctetsReadAvg": 1, + "diskOctetsReadLast": 1, + "diskOctetsReadMax": 1, + "diskOctetsReadMin": 1, + "diskOctetsWriteAvg": 1, + "diskOctetsWriteLast": 1, + "diskOctetsWriteMax": 1, + "diskOctetsWriteMin": 1, + "diskOpsReadAvg": 1, + "diskOpsReadLast": 1, + "diskOpsReadMax": 1, + "diskOpsReadMin": 1, + "diskOpsWriteAvg": 1, + "diskOpsWriteLast": 1, + "diskOpsWriteMax": 1, + "diskOpsWriteMin": 1, + "diskPendingOperationsAvg": 1, + "diskPendingOperationsLast": 1, + "diskPendingOperationsMax": 1, + "diskPendingOperationsMin": 1, + "diskTimeReadAvg": 1, + "diskTimeReadLast": 1, + "diskTimeReadMax": 1, + "diskTimeReadMin": 1, + "diskTimeWriteAvg": 1, + "diskTimeWriteLast": 1, + "diskTimeWriteMax": 1, + "diskTimeWriteMin": 1 + }, + { + "diskIdentifier": "somestring", + "diskIoTimeAvg": 1, + "diskIoTimeLast": 1, + "diskIoTimeMax": 1, + "diskIoTimeMin": 1, + "diskMergedReadAvg": 1, + "diskMergedReadLast": 1, + "diskMergedReadMax": 1, + "diskMergedReadMin": 1, + "diskMergedWriteAvg": 1, + "diskMergedWriteLast": 1, + "diskMergedWriteMax": 1, + "diskMergedWriteMin": 1, + "diskOctetsReadAvg": 1, + "diskOctetsReadLast": 1, + "diskOctetsReadMax": 1, + "diskOctetsReadMin": 1, + "diskOctetsWriteAvg": 1, + "diskOctetsWriteLast": 1, + "diskOctetsWriteMax": 1, + "diskOctetsWriteMin": 1, + "diskOpsReadAvg": 1, + "diskOpsReadLast": 1, + "diskOpsReadMax": 1, + "diskOpsReadMin": 1, + "diskOpsWriteAvg": 1, + "diskOpsWriteLast": 1, + "diskOpsWriteMax": 1, + "diskOpsWriteMin": 1, + "diskPendingOperationsAvg": 1, + "diskPendingOperationsLast": 1, + "diskPendingOperationsMax": 1, + "diskPendingOperationsMin": 1, + "diskTimeReadAvg": 1, + "diskTimeReadLast": 1, + "diskTimeReadMax": 1, + "diskTimeReadMin": 1, + "diskTimeWriteAvg": 1, + "diskTimeWriteLast": 1, + "diskTimeWriteMax": 1, + "diskTimeWriteMin": 1 + } + ], + "featureUsageArray": [ + { + "featureIdentifier": "somestring", + "featureUtilization": 1 + }, + { + "featureIdentifier": "somestring", + "featureUtilization": 1 + } + ], + "filesystemUsageArray": [ + { + "blockConfigured": 1, + "blockIops": 1, + "blockUsed": 1, + "ephemeralConfigured": 1, + "ephemeralIops": 1, + "ephemeralUsed": 1, + "filesystemName": "somestring" + }, + { + "blockConfigured": 1, + "blockIops": 1, + "blockUsed": 1, + "ephemeralConfigured": 1, + "ephemeralIops": 1, + "ephemeralUsed": 1, + "filesystemName": "somestring" + } + ], + "latencyDistribution": [ + { + "countsInTheBucket": 1, + "highEndOfLatencyBucket": 1, + "lowEndOfLatencyBucket": 1 + }, + { + "countsInTheBucket": 1, + "highEndOfLatencyBucket": 1, + "lowEndOfLatencyBucket": 1 + } + ], + "meanRequestLatency": 1, + "measurementInterval": 1, + "measurementsForVfScalingVersion": 1, + "memoryUsageArray": [ + { + "memoryBuffered": 1, + "memoryCached": 1, + "memoryConfigured": 1, + "memoryFree": 1, + "memorySlabRecl": 1, + "memorySlabUnrecl": 1, + "memoryUsed": 1, + "vmIdentifier": "somestring" + }, + { + "memoryBuffered": 1, + "memoryCached": 1, + "memoryConfigured": 1, + "memoryFree": 1, + "memorySlabRecl": 1, + "memorySlabUnrecl": 1, + "memoryUsed": 1, + "vmIdentifier": "somestring" + } + ], + "numberOfMediaPortsInUse": 1, + "requestRate": 1, + "vNicPerformanceArray": [ + { + "receivedBroadcastPacketsAccumulated": 1, + "receivedBroadcastPacketsDelta": 1, + "receivedDiscardedPacketsAccumulated": 1, + "receivedDiscardedPacketsDelta": 1, + "receivedErrorPacketsAccumulated": 1, + "receivedErrorPacketsDelta": 1, + "receivedMulticastPacketsAccumulated": 1, + "receivedMulticastPacketsDelta": 1, + "receivedOctetsAccumulated": 1, + "receivedOctetsDelta": 1, + "receivedTotalPacketsAccumulated": 1, + "receivedTotalPacketsDelta": 1, + "receivedUnicastPacketsAccumulated": 1, + "receivedUnicastPacketsDelta": 1, + "transmittedBroadcastPacketsAccumulated": 1, + "transmittedBroadcastPacketsDelta": 1, + "transmittedDiscardedPacketsAccumulated": 1, + "transmittedDiscardedPacketsDelta": 1, + "transmittedErrorPacketsAccumulated": 1, + "transmittedErrorPacketsDelta": 1, + "transmittedMulticastPacketsAccumulated": 1, + "transmittedMulticastPacketsDelta": 1, + "transmittedOctetsAccumulated": 1, + "transmittedOctetsDelta": 1, + "transmittedTotalPacketsAccumulated": 1, + "transmittedTotalPacketsDelta": 1, + "transmittedUnicastPacketsAccumulated": 1, + "transmittedUnicastPacketsDelta": 1, + "vNicIdentifier": "somestring", + "valuesAreSuspect": "true" + }, + { + "receivedBroadcastPacketsAccumulated": 1, + "receivedBroadcastPacketsDelta": 1, + "receivedDiscardedPacketsAccumulated": 1, + "receivedDiscardedPacketsDelta": 1, + "receivedErrorPacketsAccumulated": 1, + "receivedErrorPacketsDelta": 1, + "receivedMulticastPacketsAccumulated": 1, + "receivedMulticastPacketsDelta": 1, + "receivedOctetsAccumulated": 1, + "receivedOctetsDelta": 1, + "receivedTotalPacketsAccumulated": 1, + "receivedTotalPacketsDelta": 1, + "receivedUnicastPacketsAccumulated": 1, + "receivedUnicastPacketsDelta": 1, + "transmittedBroadcastPacketsAccumulated": 1, + "transmittedBroadcastPacketsDelta": 1, + "transmittedDiscardedPacketsAccumulated": 1, + "transmittedDiscardedPacketsDelta": 1, + "transmittedErrorPacketsAccumulated": 1, + "transmittedErrorPacketsDelta": 1, + "transmittedMulticastPacketsAccumulated": 1, + "transmittedMulticastPacketsDelta": 1, + "transmittedOctetsAccumulated": 1, + "transmittedOctetsDelta": 1, + "transmittedTotalPacketsAccumulated": 1, + "transmittedTotalPacketsDelta": 1, + "transmittedUnicastPacketsAccumulated": 1, + "transmittedUnicastPacketsDelta": 1, + "vNicIdentifier": "somestring", + "valuesAreSuspect": "true" + } + ], + "vnfcScalingMetric": 1 + }, + "mobileFlowFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "appProtocolType": "somestring", + "appProtocolVersion": "somestring", + "applicationType": "somestring", + "cid": "somestring", + "connectionType": "somestring", + "ecgi": "somestring", + "flowDirection": "somestring", + "gtpPerFlowMetrics": { + "avgBitErrorRate": 1, + "avgPacketDelayVariation": 1, + "avgPacketLatency": 1, + "avgReceiveThroughput": 1, + "avgTransmitThroughput": 1, + "durConnectionFailedStatus": 1, + "durTunnelFailedStatus": 1, + "flowActivatedBy": "somestring", + "flowActivationEpoch": 1, + "flowActivationMicrosec": 1, + "flowActivationTime": "somestring", + "flowDeactivatedBy": "somestring", + "flowDeactivationEpoch": 1, + "flowDeactivationMicrosec": 1, + "flowDeactivationTime": "somestring", + "flowStatus": "somestring", + "gtpConnectionStatus": "somestring", + "gtpTunnelStatus": "somestring", + "ipTosCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "ipTosList": [ + "somestring", + "somestring" + ], + "largePacketRtt": 1, + "largePacketThreshold": 1, + "maxPacketDelayVariation": 1, + "maxReceiveBitRate": 1, + "maxTransmitBitRate": 1, + "mobileQciCosCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "mobileQciCosList": [ + "somestring", + "somestring" + ], + "numActivationFailures": 1, + "numBitErrors": 1, + "numBytesReceived": 1, + "numBytesTransmitted": 1, + "numDroppedPackets": 1, + "numGtpEchoFailures": 1, + "numGtpTunnelErrors": 1, + "numHttpErrors": 1, + "numL7BytesReceived": 1, + "numL7BytesTransmitted": 1, + "numLostPackets": 1, + "numOutOfOrderPackets": 1, + "numPacketErrors": 1, + "numPacketsReceivedExclRetrans": 1, + "numPacketsReceivedInclRetrans": 1, + "numPacketsTransmittedInclRetrans": 1, + "numRetries": 1, + "numTimeouts": 1, + "numTunneledL7BytesReceived": 1, + "roundTripTime": 1, + "tcpFlagCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "tcpFlagList": [ + "somestring", + "somestring" + ], + "timeToFirstByte": 1 + }, + "gtpProtocolType": "somestring", + "gtpVersion": "somestring", + "httpHeader": "somestring", + "imei": "somestring", + "imsi": "somestring", + "ipProtocolType": "somestring", + "ipVersion": "somestring", + "lac": "somestring", + "mcc": "somestring", + "mnc": "somestring", + "mobileFlowFieldsVersion": 1, + "msisdn": "somestring", + "otherEndpointIpAddress": "somestring", + "otherEndpointPort": 1, + "otherFunctionalRole": "somestring", + "rac": "somestring", + "radioAccessTechnology": "somestring", + "reportingEndpointIpAddr": "somestring", + "reportingEndpointPort": 1, + "sac": "somestring", + "samplingAlgorithm": 1, + "tac": "somestring", + "tunnelId": "somestring", + "vlanId": "somestring" + }, + "otherFields": { + "hashOfNameValuePairArrays": [ + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + }, + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + } + ], + "jsonObjects": [ + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + }, + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + } + ], + "nameValuePairs": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "otherFieldsVersion": 1 + }, + "sipSignalingFields": { + "additionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "compressedSip": "somestring", + "correlator": "somestring", + "localIpAddress": "somestring", + "localPort": "somestring", + "remoteIpAddress": "somestring", + "remotePort": "somestring", + "sipSignalingFieldsVersion": 1, + "summarySip": "somestring", + "vendorVnfNameFields": { + "vendorName": "somestring", + "vfModuleName": "somestring", + "vnfName": "somestring" + } + }, + "stateChangeFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "newState": "inService", + "oldState": "inService", + "stateChangeFieldsVersion": 1, + "stateInterface": "somestring" + }, + "syslogFields": { + "additionalFields": "somestring", + "eventSourceHost": "somestring", + "eventSourceType": "somestring", + "syslogFacility": 1, + "syslogFieldsVersion": 1, + "syslogMsg": "somestring", + "syslogPri": 1, + "syslogProc": "somestring", + "syslogProcId": 1, + "syslogSData": "somestring", + "syslogSdId": "somestring", + "syslogSev": "Alert", + "syslogTag": "somestring", + "syslogVer": 1 + }, + "thresholdCrossingAlertFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "additionalParameters": [ + { + "criticality": "CRIT", + "name": "somestring", + "thresholdCrossed": "somestring", + "value": "somestring" + }, + { + "criticality": "CRIT", + "name": "somestring", + "thresholdCrossed": "somestring", + "value": "somestring" + } + ], + "alertAction": "CLEAR", + "alertDescription": "somestring", + "alertType": "CARD-ANOMALY", + "alertValue": "somestring", + "associatedAlertIdList": [ + "somestring", + "somestring" + ], + "collectionTimestamp": "somestring", + "dataCollector": "somestring", + "elementType": "somestring", + "eventSeverity": "CRITICAL", + "eventStartTimestamp": "somestring", + "interfaceName": "somestring", + "networkService": "somestring", + "possibleRootCause": "somestring", + "thresholdCrossingFieldsVersion": 1 + }, + "voiceQualityFields": { + "additionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "calleeSideCodec": "somestring", + "callerSideCodec": "somestring", + "correlator": "somestring", + "endOfCallVqmSummaries": { + "adjacencyName": "somestring", + "endpointDescription": "Caller", + "endpointJitter": 1, + "endpointRtpOctetsDiscarded": 1, + "endpointRtpOctetsReceived": 1, + "endpointRtpOctetsSent": 1, + "endpointRtpPacketsDiscarded": 1, + "endpointRtpPacketsReceived": 1, + "endpointRtpPacketsSent": 1, + "localJitter": 1, + "localRtpOctetsDiscarded": 1, + "localRtpOctetsReceived": 1, + "localRtpOctetsSent": 1, + "localRtpPacketsDiscarded": 1, + "localRtpPacketsReceived": 1, + "localRtpPacketsSent": 1, + "mosCqe": 1, + "packetLossPercent": 1, + "packetsLost": 1, + "rFactor": 1, + "roundTripDelay": 1 + }, + "midCallRtcp": "somestring", + "phoneNumber": "somestring", + "vendorVnfNameFields": { + "vendorName": "somestring", + "vfModuleName": "somestring", + "vnfName": "somestring" + }, + "voiceQualityFieldsVersion": 1 + } + } + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +VES Event Accepted. + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**400** +^^^^^^^ + +Bad request provided + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**401** +^^^^^^^ + +Unauthorized request + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**503** +^^^^^^^ + +Service Unavailable + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + +Security +++++++++ + +.. csv-table:: + :header: "Security Schema", "Scopes" + :widths: 15, 45 + + :ref:`basicAuth <securities_basicAuth>`, "" + + +POST ``/eventListener/v5/eventBatch`` +------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + uri for posting VES batch event objects + + +Request ++++++++ + + + +.. _d_f598222d7a83ca9c3538556b263682d1: + +Body +^^^^ + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + +.. code-block:: javascript + + { + "event": { + "commonEventHeader": { + "domain": "fault", + "eventId": "somestring", + "eventName": "somestring", + "eventType": "somestring", + "internalHeaderFields": {}, + "lastEpochMicrosec": 1, + "nfNamingCode": "somestring", + "nfcNamingCode": "somestring", + "priority": "High", + "reportingEntityId": "somestring", + "reportingEntityName": "somestring", + "sequence": 1, + "sourceId": "somestring", + "sourceName": "somestring", + "startEpochMicrosec": 1, + "version": 1 + }, + "faultFields": { + "alarmAdditionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "alarmCondition": "somestring", + "alarmInterfaceA": "somestring", + "eventCategory": "somestring", + "eventSeverity": "CRITICAL", + "eventSourceType": "somestring", + "faultFieldsVersion": 1, + "specificProblem": "somestring", + "vfStatus": "Active" + }, + "heartbeatFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "heartbeatFieldsVersion": 1, + "heartbeatInterval": 1 + }, + "measurementsForVfScalingFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "additionalMeasurements": [ + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + }, + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + } + ], + "additionalObjects": [ + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + }, + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + } + ], + "codecUsageArray": [ + { + "codecIdentifier": "somestring", + "numberInUse": 1 + }, + { + "codecIdentifier": "somestring", + "numberInUse": 1 + } + ], + "concurrentSessions": 1, + "configuredEntities": 1, + "cpuUsageArray": [ + { + "cpuIdentifier": "somestring", + "cpuIdle": 1, + "cpuUsageInterrupt": 1, + "cpuUsageNice": 1, + "cpuUsageSoftIrq": 1, + "cpuUsageSteal": 1, + "cpuUsageSystem": 1, + "cpuUsageUser": 1, + "cpuWait": 1, + "percentUsage": 1 + }, + { + "cpuIdentifier": "somestring", + "cpuIdle": 1, + "cpuUsageInterrupt": 1, + "cpuUsageNice": 1, + "cpuUsageSoftIrq": 1, + "cpuUsageSteal": 1, + "cpuUsageSystem": 1, + "cpuUsageUser": 1, + "cpuWait": 1, + "percentUsage": 1 + } + ], + "diskUsageArray": [ + { + "diskIdentifier": "somestring", + "diskIoTimeAvg": 1, + "diskIoTimeLast": 1, + "diskIoTimeMax": 1, + "diskIoTimeMin": 1, + "diskMergedReadAvg": 1, + "diskMergedReadLast": 1, + "diskMergedReadMax": 1, + "diskMergedReadMin": 1, + "diskMergedWriteAvg": 1, + "diskMergedWriteLast": 1, + "diskMergedWriteMax": 1, + "diskMergedWriteMin": 1, + "diskOctetsReadAvg": 1, + "diskOctetsReadLast": 1, + "diskOctetsReadMax": 1, + "diskOctetsReadMin": 1, + "diskOctetsWriteAvg": 1, + "diskOctetsWriteLast": 1, + "diskOctetsWriteMax": 1, + "diskOctetsWriteMin": 1, + "diskOpsReadAvg": 1, + "diskOpsReadLast": 1, + "diskOpsReadMax": 1, + "diskOpsReadMin": 1, + "diskOpsWriteAvg": 1, + "diskOpsWriteLast": 1, + "diskOpsWriteMax": 1, + "diskOpsWriteMin": 1, + "diskPendingOperationsAvg": 1, + "diskPendingOperationsLast": 1, + "diskPendingOperationsMax": 1, + "diskPendingOperationsMin": 1, + "diskTimeReadAvg": 1, + "diskTimeReadLast": 1, + "diskTimeReadMax": 1, + "diskTimeReadMin": 1, + "diskTimeWriteAvg": 1, + "diskTimeWriteLast": 1, + "diskTimeWriteMax": 1, + "diskTimeWriteMin": 1 + }, + { + "diskIdentifier": "somestring", + "diskIoTimeAvg": 1, + "diskIoTimeLast": 1, + "diskIoTimeMax": 1, + "diskIoTimeMin": 1, + "diskMergedReadAvg": 1, + "diskMergedReadLast": 1, + "diskMergedReadMax": 1, + "diskMergedReadMin": 1, + "diskMergedWriteAvg": 1, + "diskMergedWriteLast": 1, + "diskMergedWriteMax": 1, + "diskMergedWriteMin": 1, + "diskOctetsReadAvg": 1, + "diskOctetsReadLast": 1, + "diskOctetsReadMax": 1, + "diskOctetsReadMin": 1, + "diskOctetsWriteAvg": 1, + "diskOctetsWriteLast": 1, + "diskOctetsWriteMax": 1, + "diskOctetsWriteMin": 1, + "diskOpsReadAvg": 1, + "diskOpsReadLast": 1, + "diskOpsReadMax": 1, + "diskOpsReadMin": 1, + "diskOpsWriteAvg": 1, + "diskOpsWriteLast": 1, + "diskOpsWriteMax": 1, + "diskOpsWriteMin": 1, + "diskPendingOperationsAvg": 1, + "diskPendingOperationsLast": 1, + "diskPendingOperationsMax": 1, + "diskPendingOperationsMin": 1, + "diskTimeReadAvg": 1, + "diskTimeReadLast": 1, + "diskTimeReadMax": 1, + "diskTimeReadMin": 1, + "diskTimeWriteAvg": 1, + "diskTimeWriteLast": 1, + "diskTimeWriteMax": 1, + "diskTimeWriteMin": 1 + } + ], + "featureUsageArray": [ + { + "featureIdentifier": "somestring", + "featureUtilization": 1 + }, + { + "featureIdentifier": "somestring", + "featureUtilization": 1 + } + ], + "filesystemUsageArray": [ + { + "blockConfigured": 1, + "blockIops": 1, + "blockUsed": 1, + "ephemeralConfigured": 1, + "ephemeralIops": 1, + "ephemeralUsed": 1, + "filesystemName": "somestring" + }, + { + "blockConfigured": 1, + "blockIops": 1, + "blockUsed": 1, + "ephemeralConfigured": 1, + "ephemeralIops": 1, + "ephemeralUsed": 1, + "filesystemName": "somestring" + } + ], + "latencyDistribution": [ + { + "countsInTheBucket": 1, + "highEndOfLatencyBucket": 1, + "lowEndOfLatencyBucket": 1 + }, + { + "countsInTheBucket": 1, + "highEndOfLatencyBucket": 1, + "lowEndOfLatencyBucket": 1 + } + ], + "meanRequestLatency": 1, + "measurementInterval": 1, + "measurementsForVfScalingVersion": 1, + "memoryUsageArray": [ + { + "memoryBuffered": 1, + "memoryCached": 1, + "memoryConfigured": 1, + "memoryFree": 1, + "memorySlabRecl": 1, + "memorySlabUnrecl": 1, + "memoryUsed": 1, + "vmIdentifier": "somestring" + }, + { + "memoryBuffered": 1, + "memoryCached": 1, + "memoryConfigured": 1, + "memoryFree": 1, + "memorySlabRecl": 1, + "memorySlabUnrecl": 1, + "memoryUsed": 1, + "vmIdentifier": "somestring" + } + ], + "numberOfMediaPortsInUse": 1, + "requestRate": 1, + "vNicPerformanceArray": [ + { + "receivedBroadcastPacketsAccumulated": 1, + "receivedBroadcastPacketsDelta": 1, + "receivedDiscardedPacketsAccumulated": 1, + "receivedDiscardedPacketsDelta": 1, + "receivedErrorPacketsAccumulated": 1, + "receivedErrorPacketsDelta": 1, + "receivedMulticastPacketsAccumulated": 1, + "receivedMulticastPacketsDelta": 1, + "receivedOctetsAccumulated": 1, + "receivedOctetsDelta": 1, + "receivedTotalPacketsAccumulated": 1, + "receivedTotalPacketsDelta": 1, + "receivedUnicastPacketsAccumulated": 1, + "receivedUnicastPacketsDelta": 1, + "transmittedBroadcastPacketsAccumulated": 1, + "transmittedBroadcastPacketsDelta": 1, + "transmittedDiscardedPacketsAccumulated": 1, + "transmittedDiscardedPacketsDelta": 1, + "transmittedErrorPacketsAccumulated": 1, + "transmittedErrorPacketsDelta": 1, + "transmittedMulticastPacketsAccumulated": 1, + "transmittedMulticastPacketsDelta": 1, + "transmittedOctetsAccumulated": 1, + "transmittedOctetsDelta": 1, + "transmittedTotalPacketsAccumulated": 1, + "transmittedTotalPacketsDelta": 1, + "transmittedUnicastPacketsAccumulated": 1, + "transmittedUnicastPacketsDelta": 1, + "vNicIdentifier": "somestring", + "valuesAreSuspect": "true" + }, + { + "receivedBroadcastPacketsAccumulated": 1, + "receivedBroadcastPacketsDelta": 1, + "receivedDiscardedPacketsAccumulated": 1, + "receivedDiscardedPacketsDelta": 1, + "receivedErrorPacketsAccumulated": 1, + "receivedErrorPacketsDelta": 1, + "receivedMulticastPacketsAccumulated": 1, + "receivedMulticastPacketsDelta": 1, + "receivedOctetsAccumulated": 1, + "receivedOctetsDelta": 1, + "receivedTotalPacketsAccumulated": 1, + "receivedTotalPacketsDelta": 1, + "receivedUnicastPacketsAccumulated": 1, + "receivedUnicastPacketsDelta": 1, + "transmittedBroadcastPacketsAccumulated": 1, + "transmittedBroadcastPacketsDelta": 1, + "transmittedDiscardedPacketsAccumulated": 1, + "transmittedDiscardedPacketsDelta": 1, + "transmittedErrorPacketsAccumulated": 1, + "transmittedErrorPacketsDelta": 1, + "transmittedMulticastPacketsAccumulated": 1, + "transmittedMulticastPacketsDelta": 1, + "transmittedOctetsAccumulated": 1, + "transmittedOctetsDelta": 1, + "transmittedTotalPacketsAccumulated": 1, + "transmittedTotalPacketsDelta": 1, + "transmittedUnicastPacketsAccumulated": 1, + "transmittedUnicastPacketsDelta": 1, + "vNicIdentifier": "somestring", + "valuesAreSuspect": "true" + } + ], + "vnfcScalingMetric": 1 + }, + "mobileFlowFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "appProtocolType": "somestring", + "appProtocolVersion": "somestring", + "applicationType": "somestring", + "cid": "somestring", + "connectionType": "somestring", + "ecgi": "somestring", + "flowDirection": "somestring", + "gtpPerFlowMetrics": { + "avgBitErrorRate": 1, + "avgPacketDelayVariation": 1, + "avgPacketLatency": 1, + "avgReceiveThroughput": 1, + "avgTransmitThroughput": 1, + "durConnectionFailedStatus": 1, + "durTunnelFailedStatus": 1, + "flowActivatedBy": "somestring", + "flowActivationEpoch": 1, + "flowActivationMicrosec": 1, + "flowActivationTime": "somestring", + "flowDeactivatedBy": "somestring", + "flowDeactivationEpoch": 1, + "flowDeactivationMicrosec": 1, + "flowDeactivationTime": "somestring", + "flowStatus": "somestring", + "gtpConnectionStatus": "somestring", + "gtpTunnelStatus": "somestring", + "ipTosCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "ipTosList": [ + "somestring", + "somestring" + ], + "largePacketRtt": 1, + "largePacketThreshold": 1, + "maxPacketDelayVariation": 1, + "maxReceiveBitRate": 1, + "maxTransmitBitRate": 1, + "mobileQciCosCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "mobileQciCosList": [ + "somestring", + "somestring" + ], + "numActivationFailures": 1, + "numBitErrors": 1, + "numBytesReceived": 1, + "numBytesTransmitted": 1, + "numDroppedPackets": 1, + "numGtpEchoFailures": 1, + "numGtpTunnelErrors": 1, + "numHttpErrors": 1, + "numL7BytesReceived": 1, + "numL7BytesTransmitted": 1, + "numLostPackets": 1, + "numOutOfOrderPackets": 1, + "numPacketErrors": 1, + "numPacketsReceivedExclRetrans": 1, + "numPacketsReceivedInclRetrans": 1, + "numPacketsTransmittedInclRetrans": 1, + "numRetries": 1, + "numTimeouts": 1, + "numTunneledL7BytesReceived": 1, + "roundTripTime": 1, + "tcpFlagCountList": [ + [ + 1, + 1 + ], + [ + 1, + 1 + ] + ], + "tcpFlagList": [ + "somestring", + "somestring" + ], + "timeToFirstByte": 1 + }, + "gtpProtocolType": "somestring", + "gtpVersion": "somestring", + "httpHeader": "somestring", + "imei": "somestring", + "imsi": "somestring", + "ipProtocolType": "somestring", + "ipVersion": "somestring", + "lac": "somestring", + "mcc": "somestring", + "mnc": "somestring", + "mobileFlowFieldsVersion": 1, + "msisdn": "somestring", + "otherEndpointIpAddress": "somestring", + "otherEndpointPort": 1, + "otherFunctionalRole": "somestring", + "rac": "somestring", + "radioAccessTechnology": "somestring", + "reportingEndpointIpAddr": "somestring", + "reportingEndpointPort": 1, + "sac": "somestring", + "samplingAlgorithm": 1, + "tac": "somestring", + "tunnelId": "somestring", + "vlanId": "somestring" + }, + "otherFields": { + "hashOfNameValuePairArrays": [ + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + }, + { + "arrayOfFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "name": "somestring" + } + ], + "jsonObjects": [ + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + }, + { + "nfSubscribedObjectName": "somestring", + "nfSubscriptionId": "somestring", + "objectInstances": [ + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + }, + { + "objectInstance": {}, + "objectInstanceEpochMicrosec": 1, + "objectKeys": [ + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + }, + { + "keyName": "somestring", + "keyOrder": 1, + "keyValue": "somestring" + } + ] + } + ], + "objectName": "somestring", + "objectSchema": "somestring", + "objectSchemaUrl": "somestring" + } + ], + "nameValuePairs": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "otherFieldsVersion": 1 + }, + "sipSignalingFields": { + "additionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "compressedSip": "somestring", + "correlator": "somestring", + "localIpAddress": "somestring", + "localPort": "somestring", + "remoteIpAddress": "somestring", + "remotePort": "somestring", + "sipSignalingFieldsVersion": 1, + "summarySip": "somestring", + "vendorVnfNameFields": { + "vendorName": "somestring", + "vfModuleName": "somestring", + "vnfName": "somestring" + } + }, + "stateChangeFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "newState": "inService", + "oldState": "inService", + "stateChangeFieldsVersion": 1, + "stateInterface": "somestring" + }, + "syslogFields": { + "additionalFields": "somestring", + "eventSourceHost": "somestring", + "eventSourceType": "somestring", + "syslogFacility": 1, + "syslogFieldsVersion": 1, + "syslogMsg": "somestring", + "syslogPri": 1, + "syslogProc": "somestring", + "syslogProcId": 1, + "syslogSData": "somestring", + "syslogSdId": "somestring", + "syslogSev": "Alert", + "syslogTag": "somestring", + "syslogVer": 1 + }, + "thresholdCrossingAlertFields": { + "additionalFields": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "additionalParameters": [ + { + "criticality": "CRIT", + "name": "somestring", + "thresholdCrossed": "somestring", + "value": "somestring" + }, + { + "criticality": "CRIT", + "name": "somestring", + "thresholdCrossed": "somestring", + "value": "somestring" + } + ], + "alertAction": "CLEAR", + "alertDescription": "somestring", + "alertType": "CARD-ANOMALY", + "alertValue": "somestring", + "associatedAlertIdList": [ + "somestring", + "somestring" + ], + "collectionTimestamp": "somestring", + "dataCollector": "somestring", + "elementType": "somestring", + "eventSeverity": "CRITICAL", + "eventStartTimestamp": "somestring", + "interfaceName": "somestring", + "networkService": "somestring", + "possibleRootCause": "somestring", + "thresholdCrossingFieldsVersion": 1 + }, + "voiceQualityFields": { + "additionalInformation": [ + { + "name": "somestring", + "value": "somestring" + }, + { + "name": "somestring", + "value": "somestring" + } + ], + "calleeSideCodec": "somestring", + "callerSideCodec": "somestring", + "correlator": "somestring", + "endOfCallVqmSummaries": { + "adjacencyName": "somestring", + "endpointDescription": "Caller", + "endpointJitter": 1, + "endpointRtpOctetsDiscarded": 1, + "endpointRtpOctetsReceived": 1, + "endpointRtpOctetsSent": 1, + "endpointRtpPacketsDiscarded": 1, + "endpointRtpPacketsReceived": 1, + "endpointRtpPacketsSent": 1, + "localJitter": 1, + "localRtpOctetsDiscarded": 1, + "localRtpOctetsReceived": 1, + "localRtpOctetsSent": 1, + "localRtpPacketsDiscarded": 1, + "localRtpPacketsReceived": 1, + "localRtpPacketsSent": 1, + "mosCqe": 1, + "packetLossPercent": 1, + "packetsLost": 1, + "rFactor": 1, + "roundTripDelay": 1 + }, + "midCallRtcp": "somestring", + "phoneNumber": "somestring", + "vendorVnfNameFields": { + "vendorName": "somestring", + "vfModuleName": "somestring", + "vnfName": "somestring" + }, + "voiceQualityFieldsVersion": 1 + } + } + } + +Responses ++++++++++ + +**200** +^^^^^^^ + +VES Event Accepted. + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**400** +^^^^^^^ + +Bad request provided + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**401** +^^^^^^^ + +Unauthorized request + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + +**503** +^^^^^^^ + +Service Unavailable + + +Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` + +**Example:** + +.. code-block:: javascript + + { + "code": 1, + "message": "somestring", + "type": "somestring" + } + + + +Security +++++++++ + +.. csv-table:: + :header: "Security Schema", "Scopes" + :widths: 15, 45 + + :ref:`basicAuth <securities_basicAuth>`, "" + +Data Structures +~~~~~~~~~~~~~~~ + +.. _d_8a94f348f7df00259702f8d9b7d2ea84: + +ApiResponseMessage Model Structure +---------------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + code | No | integer | int32 | | + message | No | string | | | + type | No | string | | | + +.. _d_f598222d7a83ca9c3538556b263682d1: + +VES5Request Model Structure +--------------------------- + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + +.. _d_df249c51a416f54e5609f2ffffe059c0: + +codecsInUse Model Structure +--------------------------- + +number of times an identified codec was used over the measurementInterval + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + codecIdentifier | Yes | string | | | + numberInUse | Yes | integer | | | + +.. _d_a68e1b21fdcef792db73f711201c56ad: + +command Model Structure +----------------------- + +command from an event collector toward an event source + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} | + eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | | + heartbeatInterval | No | integer | | | + measurementInterval | No | integer | | | + +.. _d_2dc9a27be1410f60241c5f63c636bb7e: + +commonEventHeader Model Structure +--------------------------------- + +fields common to all events + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + domain | Yes | string | | {'enum': ['fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality']} | the eventing domain associated with the event + eventId | Yes | string | | | event key that is unique to the event source + eventName | Yes | string | | | unique event name + eventType | No | string | | | for example - applicationVnf, guestOS, hostOS, platform + internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | | + lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + nfNamingCode | No | string | | | 4 character network function type, aligned with vnf naming standards + nfcNamingCode | No | string | | | 3 character network function component type, aligned with vfc naming standards + priority | Yes | string | | {'enum': ['High', 'Medium', 'Normal', 'Low']} | processing priority + reportingEntityId | No | string | | | UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process + reportingEntityName | Yes | string | | | name of the entity reporting the event, for example, an EMS name; may be the same as sourceName + sequence | Yes | integer | | | ordering of events communicated by an event source instance or 0 if not needed + sourceId | No | string | | | UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process + sourceName | Yes | string | | | name of the entity experiencing the event issue + startEpochMicrosec | Yes | number | | | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + version | Yes | number | | | version of the event header + +.. _d_6e043350cba5faafe21de49c2f6fd745: + +counter Model Structure +----------------------- + +performance counter + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} | + name | Yes | string | | | + thresholdCrossed | Yes | string | | | + value | Yes | string | | | + +.. _d_6f081937f31c09078c8acf9212d6c449: + +cpuUsage Model Structure +------------------------ + +usage of an identified CPU + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + cpuIdentifier | Yes | string | | | cpu identifer + cpuIdle | No | number | | | percentage of CPU time spent in the idle task + cpuUsageInterrupt | No | number | | | percentage of time spent servicing interrupts + cpuUsageNice | No | number | | | percentage of time spent running user space processes that have been niced + cpuUsageSoftIrq | No | number | | | percentage of time spent handling soft irq interrupts + cpuUsageSteal | No | number | | | percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing + cpuUsageSystem | No | number | | | percentage of time spent on system tasks running the kernel + cpuUsageUser | No | number | | | percentage of time spent running un-niced user space processes + cpuWait | No | number | | | percentage of CPU time spent waiting for I/O operations to complete + percentUsage | Yes | number | | | aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running + +.. _d_bb7a69764c21219953df76826934938e: + +diskUsage Model Structure +------------------------- + +usage of an identified disk + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + diskIdentifier | Yes | string | | | disk identifier + diskIoTimeAvg | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval + diskIoTimeLast | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval + diskIoTimeMax | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval + diskIoTimeMin | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval + diskMergedReadAvg | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval + diskMergedReadLast | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval + diskMergedReadMax | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval + diskMergedReadMin | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval + diskMergedWriteAvg | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval + diskMergedWriteLast | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval + diskMergedWriteMax | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval + diskMergedWriteMin | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval + diskOctetsReadAvg | No | number | | | number of octets per second read from a disk or partition; provide the average measurement within the measurement interval + diskOctetsReadLast | No | number | | | number of octets per second read from a disk or partition; provide the last measurement within the measurement interval + diskOctetsReadMax | No | number | | | number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval + diskOctetsReadMin | No | number | | | number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval + diskOctetsWriteAvg | No | number | | | number of octets per second written to a disk or partition; provide the average measurement within the measurement interval + diskOctetsWriteLast | No | number | | | number of octets per second written to a disk or partition; provide the last measurement within the measurement interval + diskOctetsWriteMax | No | number | | | number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval + diskOctetsWriteMin | No | number | | | number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval + diskOpsReadAvg | No | number | | | number of read operations per second issued to the disk; provide the average measurement within the measurement interval + diskOpsReadLast | No | number | | | number of read operations per second issued to the disk; provide the last measurement within the measurement interval + diskOpsReadMax | No | number | | | number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval + diskOpsReadMin | No | number | | | number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval + diskOpsWriteAvg | No | number | | | number of write operations per second issued to the disk; provide the average measurement within the measurement interval + diskOpsWriteLast | No | number | | | number of write operations per second issued to the disk; provide the last measurement within the measurement interval + diskOpsWriteMax | No | number | | | number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval + diskOpsWriteMin | No | number | | | number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval + diskPendingOperationsAvg | No | number | | | queue size of pending I/O operations per second; provide the average measurement within the measurement interval + diskPendingOperationsLast | No | number | | | queue size of pending I/O operations per second; provide the last measurement within the measurement interval + diskPendingOperationsMax | No | number | | | queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval + diskPendingOperationsMin | No | number | | | queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval + diskTimeReadAvg | No | number | | | milliseconds a read operation took to complete; provide the average measurement within the measurement interval + diskTimeReadLast | No | number | | | milliseconds a read operation took to complete; provide the last measurement within the measurement interval + diskTimeReadMax | No | number | | | milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval + diskTimeReadMin | No | number | | | milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval + diskTimeWriteAvg | No | number | | | milliseconds a write operation took to complete; provide the average measurement within the measurement interval + diskTimeWriteLast | No | number | | | milliseconds a write operation took to complete; provide the last measurement within the measurement interval + diskTimeWriteMax | No | number | | | milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval + diskTimeWriteMin | No | number | | | milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval + +.. _d_c911a0a8abdb511d7cd6590f383d817b: + +endOfCallVqmSummaries Model Structure +------------------------------------- + +provides end of call voice quality metrics + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + adjacencyName | Yes | string | | | adjacency name + endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee + endpointJitter | No | number | | | + endpointRtpOctetsDiscarded | No | number | | | + endpointRtpOctetsReceived | No | number | | | + endpointRtpOctetsSent | No | number | | | + endpointRtpPacketsDiscarded | No | number | | | + endpointRtpPacketsReceived | No | number | | | + endpointRtpPacketsSent | No | number | | | + localJitter | No | number | | | + localRtpOctetsDiscarded | No | number | | | + localRtpOctetsReceived | No | number | | | + localRtpOctetsSent | No | number | | | + localRtpPacketsDiscarded | No | number | | | + localRtpPacketsReceived | No | number | | | + localRtpPacketsSent | No | number | | | + mosCqe | No | number | | | 1-5 1dp + packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp) + packetsLost | No | number | | | + rFactor | No | number | | | 0-100 + roundTripDelay | No | number | | | millisecs + +.. _d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb: + +event Model Structure +--------------------- + +the root level of the common event format + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | | + faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | | + heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | | + measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | | + mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | | + otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | | + sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | | + stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | | + syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | | + thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | | + voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | | + +.. _d_4089a4a9ee684770c6f37a588a577589: + +eventDomainThrottleSpecification Model Structure +------------------------------------------------ + +specification of what information to suppress within an event domain + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + eventDomain | Yes | string | | | Event domain enum from the commonEventHeader domain field + suppressedFieldNames | No | array of string | | | List of optional field names in the event block that should not be sent to the Event Listener + suppressedNvPairsList | No | array of :ref:`suppressedNvPairs <d_52877eda2d273b282063857f97fa7ff4>` | | | Optional list of specific NvPairsNames to suppress within a given Name-Value Field + +.. _d_e7aa5254472f7823fdd6d5a090bfd0a4: + +faultFields Model Structure +--------------------------- + +fields specific to fault events + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + alarmAdditionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional alarm information + alarmCondition | Yes | string | | | alarm condition reported by the device + alarmInterfaceA | No | string | | | card, port, channel or interface name of the device generating the alarm + eventCategory | No | string | | | Event category, for example: license, link, routing, security, signaling + eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity + eventSourceType | Yes | string | | | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction + faultFieldsVersion | Yes | number | | | version of the faultFields block + specificProblem | Yes | string | | | short description of the alarm or problem + vfStatus | Yes | string | | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration + +.. _d_76d7f35861442236cee9f716ea1e1540: + +featuresInUse Model Structure +----------------------------- + +number of times an identified feature was used over the measurementInterval + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + featureIdentifier | Yes | string | | | + featureUtilization | Yes | integer | | | + +.. _d_a9799335edbbc52c7f0c5191f7bd09ee: + +field Model Structure +--------------------- + +name value pair + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + name | Yes | string | | | + value | Yes | string | | | + +.. _d_18e1fa5fd6774deefce826b075f8b6e7: + +filesystemUsage Model Structure +------------------------------- + +disk usage of an identified virtual machine in gigabytes and/or gigabytes per second + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + blockConfigured | Yes | number | | | + blockIops | Yes | number | | | + blockUsed | Yes | number | | | + ephemeralConfigured | Yes | number | | | + ephemeralIops | Yes | number | | | + ephemeralUsed | Yes | number | | | + filesystemName | Yes | string | | | + +.. _d_bb1527d221e848e0896c78552979238b: + +gtpPerFlowMetrics Model Structure +--------------------------------- + +Mobility GTP Protocol per flow metrics + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + avgBitErrorRate | Yes | number | | | average bit error rate + avgPacketDelayVariation | Yes | number | | | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets + avgPacketLatency | Yes | number | | | average delivery latency + avgReceiveThroughput | Yes | number | | | average receive throughput + avgTransmitThroughput | Yes | number | | | average transmit throughput + durConnectionFailedStatus | No | number | | | duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval + durTunnelFailedStatus | No | number | | | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval + flowActivatedBy | No | string | | | Endpoint activating the flow + flowActivationEpoch | Yes | number | | | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available + flowActivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection + flowActivationTime | No | string | | | time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 + flowDeactivatedBy | No | string | | | Endpoint deactivating the flow + flowDeactivationEpoch | Yes | number | | | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time + flowDeactivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection + flowDeactivationTime | Yes | string | | | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 + flowStatus | Yes | string | | | connection status at reporting time as a working / inactive / failed indicator value + gtpConnectionStatus | No | string | | | Current connection state at reporting time + gtpTunnelStatus | No | string | | | Current tunnel state at reporting time + ipTosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow + ipTosList | No | array of string | | | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' + largePacketRtt | No | number | | | large packet round trip time + largePacketThreshold | No | number | | | large packet threshold being applied + maxPacketDelayVariation | Yes | number | | | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets + maxReceiveBitRate | No | number | | | maximum receive bit rate + maxTransmitBitRate | No | number | | | maximum transmit bit rate + mobileQciCosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow + mobileQciCosList | No | array of string | | | Array of unique LTE QCI or UMTS class-of-service values observed in the flow + numActivationFailures | Yes | number | | | Number of failed activation requests, as observed by the reporting node + numBitErrors | Yes | number | | | number of errored bits + numBytesReceived | Yes | number | | | number of bytes received, including retransmissions + numBytesTransmitted | Yes | number | | | number of bytes transmitted, including retransmissions + numDroppedPackets | Yes | number | | | number of received packets dropped due to errors per virtual interface + numGtpEchoFailures | No | number | | | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 + numGtpTunnelErrors | No | number | | | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 + numHttpErrors | No | number | | | Http error count + numL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, including retransmissions + numL7BytesTransmitted | Yes | number | | | number of tunneled layer 7 bytes transmitted, excluding retransmissions + numLostPackets | Yes | number | | | number of lost packets + numOutOfOrderPackets | Yes | number | | | number of out-of-order packets + numPacketErrors | Yes | number | | | number of errored packets + numPacketsReceivedExclRetrans | Yes | number | | | number of packets received, excluding retransmission + numPacketsReceivedInclRetrans | Yes | number | | | number of packets received, including retransmission + numPacketsTransmittedInclRetrans | Yes | number | | | number of packets transmitted, including retransmissions + numRetries | Yes | number | | | number of packet retries + numTimeouts | Yes | number | | | number of packet timeouts + numTunneledL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, excluding retransmissions + roundTripTime | Yes | number | | | round trip time + tcpFlagCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow + tcpFlagList | No | array of string | | | Array of unique TCP Flags observed in the flow + timeToFirstByte | Yes | number | | | Time in milliseconds between the connection activation and first byte received + +.. _d_6ea626e11ce7887cddd39c36ff4f0926: + +heartbeatFields Model Structure +------------------------------- + +optional field block for fields specific to heartbeat events + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional heartbeat fields if needed + heartbeatFieldsVersion | Yes | number | | | version of the heartbeatFields block + heartbeatInterval | Yes | integer | | | current heartbeat interval in seconds + +.. _d_2873d30f54c59ef635c1fc0cbbaa89f1: + +internalHeaderFields Model Structure +------------------------------------ + +enrichment fields for internal VES Event Listener service use only, not supplied by event sources + + + +.. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54: + +jsonObject Model Structure +-------------------------- + +json object schema, name and other meta-information along with one or more object instances + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + nfSubscribedObjectName | No | string | | | name of the object associated with the nfSubscriptonId + nfSubscriptionId | No | string | | | identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject + objectInstances | Yes | array of :ref:`jsonObjectInstance <d_7bccbee07bd3044bd0b929cb6b567c03>` | | | one or more instances of the jsonObject + objectName | Yes | string | | | name of the JSON Object + objectSchema | No | string | | | json schema for the object + objectSchemaUrl | No | string | | | Url to the json schema for the object + +.. _d_7bccbee07bd3044bd0b929cb6b567c03: + +jsonObjectInstance Model Structure +---------------------------------- + +meta-information about an instance of a jsonObject along with the actual object instance + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + objectInstance | Yes | :ref:`objectInstance <i_c0493c6178d712e91e73c63587e27067>` | | | an instance conforming to the jsonObject schema + objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds + objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` | | | an ordered set of keys that identifies this particular instance of jsonObject + +.. _i_c0493c6178d712e91e73c63587e27067: + +**Objectinstance schema:** + + +an instance conforming to the jsonObject schema + + + +.. _d_a217491e9c44487ec7bbd9ce3ac9dddb: + +key Model Structure +------------------- + +tuple which provides the name of a key along with its value and relative order + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + keyName | Yes | string | | | name of the key + keyOrder | No | integer | | | relative sequence or order of the key with respect to other keys + keyValue | No | string | | | value of the key + +.. _d_dc21244021b6cb0e0af16166e4600d99: + +latencyBucketMeasure Model Structure +------------------------------------ + +number of counts falling within a defined latency bucket + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + countsInTheBucket | Yes | number | | | + highEndOfLatencyBucket | No | number | | | + lowEndOfLatencyBucket | No | number | | | + +.. _d_669cf98e276c9992abd27056c432bbb2: + +measurementsForVfScalingFields Model Structure +---------------------------------------------- + +measurementsForVfScaling fields + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional name-value-pair fields + additionalMeasurements | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays + additionalObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information + codecUsageArray | No | array of :ref:`codecsInUse <d_df249c51a416f54e5609f2ffffe059c0>` | | | array of codecs in use + concurrentSessions | No | integer | | | peak concurrent sessions for the VM or VNF over the measurementInterval + configuredEntities | No | integer | | | over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF + cpuUsageArray | No | array of :ref:`cpuUsage <d_6f081937f31c09078c8acf9212d6c449>` | | | usage of an array of CPUs + diskUsageArray | No | array of :ref:`diskUsage <d_bb7a69764c21219953df76826934938e>` | | | usage of an array of disks + featureUsageArray | No | array of :ref:`featuresInUse <d_76d7f35861442236cee9f716ea1e1540>` | | | array of features in use + filesystemUsageArray | No | array of :ref:`filesystemUsage <d_18e1fa5fd6774deefce826b075f8b6e7>` | | | filesystem usage of the VM on which the VNFC reporting the event is running + latencyDistribution | No | array of :ref:`latencyBucketMeasure <d_dc21244021b6cb0e0af16166e4600d99>` | | | array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges + meanRequestLatency | No | number | | | mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running + measurementInterval | Yes | number | | | interval over which measurements are being reported in seconds + measurementsForVfScalingVersion | Yes | number | | | version of the measurementsForVfScaling block + memoryUsageArray | No | array of :ref:`memoryUsage <d_7a758ee807f435a8ba5568e6da6ed597>` | | | memory usage of an array of VMs + numberOfMediaPortsInUse | No | integer | | | number of media ports in use + requestRate | No | number | | | peak rate of service requests per second to the VNF over the measurementInterval + vNicPerformanceArray | No | array of :ref:`vNicPerformance <d_b845a2955da4c78bef3ba4d50021a240>` | | | usage of an array of virtual network interface cards + vnfcScalingMetric | No | integer | | | represents busy-ness of the VNF from 0 to 100 as reported by the VNFC + +.. _d_7a758ee807f435a8ba5568e6da6ed597: + +memoryUsage Model Structure +--------------------------- + +memory usage of an identified virtual machine + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + memoryBuffered | No | number | | | kibibytes of temporary storage for raw disk blocks + memoryCached | No | number | | | kibibytes of memory used for cache + memoryConfigured | No | number | | | kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running + memoryFree | Yes | number | | | kibibytes of physical RAM left unused by the system + memorySlabRecl | No | number | | | the part of the slab that can be reclaimed such as caches measured in kibibytes + memorySlabUnrecl | No | number | | | the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes + memoryUsed | Yes | number | | | total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes + vmIdentifier | Yes | string | | | virtual machine identifier associated with the memory metrics + +.. _d_dc18fe1d28fe3ef664c3f4ab777d8424: + +mobileFlowFields Model Structure +-------------------------------- + +mobileFlow fields + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional mobileFlow fields if needed + appProtocolType | No | string | | | application protocol + appProtocolVersion | No | string | | | application protocol version + applicationType | No | string | | | Application type inferred + cid | No | string | | | cell id + connectionType | No | string | | | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc + ecgi | No | string | | | Evolved Cell Global Id + flowDirection | Yes | string | | | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow + gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | | + gtpProtocolType | No | string | | | GTP protocol + gtpVersion | No | string | | | GTP protocol version + httpHeader | No | string | | | HTTP request header, if the flow connects to a node referenced by HTTP + imei | No | string | | | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device + imsi | No | string | | | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device + ipProtocolType | Yes | string | | | IP protocol type e.g., TCP, UDP, RTP... + ipVersion | Yes | string | | | IP protocol version e.g., IPv4, IPv6 + lac | No | string | | | location area code + mcc | No | string | | | mobile country code + mnc | No | string | | | mobile network code + mobileFlowFieldsVersion | Yes | number | | | version of the mobileFlowFields block + msisdn | No | string | | | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device + otherEndpointIpAddress | Yes | string | | | IP address for the other endpoint, as used for the flow being reported on + otherEndpointPort | Yes | integer | | | IP Port for the reporting entity, as used for the flow being reported on + otherFunctionalRole | No | string | | | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... + rac | No | string | | | routing area code + radioAccessTechnology | No | string | | | Radio Access Technology e.g., 2G, 3G, LTE + reportingEndpointIpAddr | Yes | string | | | IP address for the reporting entity, as used for the flow being reported on + reportingEndpointPort | Yes | integer | | | IP port for the reporting entity, as used for the flow being reported on + sac | No | string | | | service area code + samplingAlgorithm | No | integer | | | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied + tac | No | string | | | transport area code + tunnelId | No | string | | | tunnel identifier + vlanId | No | string | | | VLAN identifier used by this flow + +.. _d_38de3331d60414da3eea18e8f7e0ecf9: + +namedArrayOfFields Model Structure +---------------------------------- + +an array of name value pairs along with a name for the array + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs + name | Yes | string | | | + +.. _d_5a79cd7ce784d60fd832d9c7c0a24322: + +otherFields Model Structure +--------------------------- + +fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + hashOfNameValuePairArrays | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays + jsonObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information + nameValuePairs | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name-value pairs + otherFieldsVersion | Yes | number | | | version of the otherFields block + +.. _d_6747334473cf2b305fe43b61a40656e1: + +requestError Model Structure +---------------------------- + +standard request error data structure + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + messageId | Yes | string | | | Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception + text | Yes | string | | | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 + url | No | string | | | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents + variables | No | string | | | List of zero or more strings that represent the contents of the variables used by the message text + +.. _d_c3e191f0b26ddd68f927ac0c8b551c5e: + +sipSignalingFields Model Structure +---------------------------------- + +sip signaling fields + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional sip signaling fields if needed + compressedSip | No | string | | | the full SIP request/response including headers and bodies + correlator | Yes | string | | | this is the same for all events on this call + localIpAddress | Yes | string | | | IP address on VNF + localPort | Yes | string | | | port on VNF + remoteIpAddress | Yes | string | | | IP address of peer endpoint + remotePort | Yes | string | | | port of peer endpoint + sipSignalingFieldsVersion | Yes | number | | | version of the sipSignalingFields block + summarySip | No | string | | | the SIP Method or Response (INVITE, 200 OK, BYE, etc) + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + +.. _d_c5450f1a263d0a2b0c64c96119f7d759: + +stateChangeFields Model Structure +--------------------------------- + +stateChange fields + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional stateChange fields if needed + newState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | new state of the entity + oldState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | previous state of the entity + stateChangeFieldsVersion | Yes | number | | | version of the stateChangeFields block + stateInterface | Yes | string | | | card or port name of the entity that changed state + +.. _d_52877eda2d273b282063857f97fa7ff4: + +suppressedNvPairs Model Structure +--------------------------------- + +List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + nvPairFieldName | Yes | string | | | Name of the field within which are the nvpair names to suppress + suppressedNvPairNames | Yes | array of string | | | Array of nvpair names to suppress within the nvpairFieldName + +.. _d_782271970af04a3b0e5a5da9b30996d2: + +syslogFields Model Structure +---------------------------- + +sysLog fields + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | string | | | additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|' + eventSourceHost | No | string | | | hostname of the device + eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction + syslogFacility | No | integer | | | numeric code from 0 to 23 for facility--see table in documentation + syslogFieldsVersion | Yes | number | | | version of the syslogFields block + syslogMsg | Yes | string | | | syslog message + syslogPri | No | integer | | | 0-192 combined severity and facility + syslogProc | No | string | | | identifies the application that originated the message + syslogProcId | No | number | | | a change in the value of this field indicates a discontinuity in syslog reporting + syslogSData | No | string | | | syslog structured data consisting of a structured data Id followed by a set of key value pairs + syslogSdId | No | string | | | 0-32 char in format name@number for example ourSDID@32473 + syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8 + syslogTag | Yes | string | | | msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided + syslogVer | No | number | | | IANA assigned version of the syslog protocol specification - typically 1 + +.. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20: + +thresholdCrossingAlertFields Model Structure +-------------------------------------------- + +fields specific to threshold crossing alert events + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional threshold crossing alert fields if needed + additionalParameters | Yes | array of :ref:`counter <d_6e043350cba5faafe21de49c2f6fd745>` | | | performance counters + alertAction | Yes | string | | {'enum': ['CLEAR', 'CONT', 'SET']} | Event action + alertDescription | Yes | string | | | Unique short alert description such as IF-SHUB-ERRDROP + alertType | Yes | string | | {'enum': ['CARD-ANOMALY', 'ELEMENT-ANOMALY', 'INTERFACE-ANOMALY', 'SERVICE-ANOMALY']} | Event type + alertValue | No | string | | | Calculated API value (if applicable) + associatedAlertIdList | No | array of string | | | List of eventIds associated with the event being reported + collectionTimestamp | Yes | string | | | Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 + dataCollector | No | string | | | Specific performance collector instance used + elementType | No | string | | | type of network element - internal ATT field + eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity or priority + eventStartTimestamp | Yes | string | | | Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 + interfaceName | No | string | | | Physical or logical port or card (if applicable) + networkService | No | string | | | network name - internal ATT field + possibleRootCause | No | string | | | Reserved for future use + thresholdCrossingFieldsVersion | Yes | number | | | version of the thresholdCrossingAlertFields block + +.. _d_b845a2955da4c78bef3ba4d50021a240: + +vNicPerformance Model Structure +------------------------------- + +describes the performance and errors of an identified virtual network interface card + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + receivedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets received as read at the end of the measurement interval + receivedBroadcastPacketsDelta | No | number | | | Count of broadcast packets received within the measurement interval + receivedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets received as read at the end of the measurement interval + receivedDiscardedPacketsDelta | No | number | | | Count of discarded packets received within the measurement interval + receivedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets received as read at the end of the measurement interval + receivedErrorPacketsDelta | No | number | | | Count of error packets received within the measurement interval + receivedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets received as read at the end of the measurement interval + receivedMulticastPacketsDelta | No | number | | | Count of multicast packets received within the measurement interval + receivedOctetsAccumulated | No | number | | | Cumulative count of octets received as read at the end of the measurement interval + receivedOctetsDelta | No | number | | | Count of octets received within the measurement interval + receivedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets received as read at the end of the measurement interval + receivedTotalPacketsDelta | No | number | | | Count of all packets received within the measurement interval + receivedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets received as read at the end of the measurement interval + receivedUnicastPacketsDelta | No | number | | | Count of unicast packets received within the measurement interval + transmittedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval + transmittedBroadcastPacketsDelta | No | number | | | Count of broadcast packets transmitted within the measurement interval + transmittedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets transmitted as read at the end of the measurement interval + transmittedDiscardedPacketsDelta | No | number | | | Count of discarded packets transmitted within the measurement interval + transmittedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets transmitted as read at the end of the measurement interval + transmittedErrorPacketsDelta | No | number | | | Count of error packets transmitted within the measurement interval + transmittedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets transmitted as read at the end of the measurement interval + transmittedMulticastPacketsDelta | No | number | | | Count of multicast packets transmitted within the measurement interval + transmittedOctetsAccumulated | No | number | | | Cumulative count of octets transmitted as read at the end of the measurement interval + transmittedOctetsDelta | No | number | | | Count of octets transmitted within the measurement interval + transmittedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets transmitted as read at the end of the measurement interval + transmittedTotalPacketsDelta | No | number | | | Count of all packets transmitted within the measurement interval + transmittedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets transmitted as read at the end of the measurement interval + transmittedUnicastPacketsDelta | No | number | | | Count of unicast packets transmitted within the measurement interval + vNicIdentifier | Yes | string | | | vNic identification + valuesAreSuspect | Yes | string | | {'enum': ['true', 'false']} | Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions + +.. _d_d694eebbbc0078612d2ba22e0cbf814c: + +vendorVnfNameFields Model Structure +----------------------------------- + +provides vendor, vnf and vfModule identifying information + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + vendorName | Yes | string | | | VNF vendor name + vfModuleName | No | string | | | ASDC vfModuleName for the vfModule generating the event + vnfName | No | string | | | ASDC modelName for the VNF generating the event + +.. _d_9551641bd1c775d9fcf4e45353de8e43: + +voiceQualityFields Model Structure +---------------------------------- + +provides statistics related to customer facing voice products + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional voice quality fields if needed + calleeSideCodec | Yes | string | | | callee codec for the call + callerSideCodec | Yes | string | | | caller codec for the call + correlator | Yes | string | | | this is the same for all events on this call + endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | | + midCallRtcp | Yes | string | | | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers + phoneNumber | No | string | | | phone number associated with the correlator + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block + diff --git a/docs/sections/apis/ves.yaml b/docs/sections/apis/ves.yaml new file mode 100644 index 00000000..0c8a5b53 --- /dev/null +++ b/docs/sections/apis/ves.yaml @@ -0,0 +1,1927 @@ +swagger: '2.0' +info: + version: 1.1.0 + title: VES Collector + description: > + Virtual Event Streaming (VES) Collector is RESTful collector for processing + JSON messages. The collector verifies the source and validates the events + against VES schema before distributing to DMAAP MR topics + contact: + email: dcae@lists.openecomp.org +externalDocs: + description: VESCollector + url: 'https://gerrit.onap.org/r/#/admin/projects/dcaegen2/collectors/ves' +schemes: + - http + - https +securityDefinitions: + basicAuth: + type: basic + description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +paths: + /eventListener/v5: + post: + security: + - basicAuth: [] + summary: '' + description: uri for posting VES event objects + operationId: veseventPut + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/VES5Request' + responses: + '200': + description: VES Event Accepted. + schema: + $ref: '#/definitions/ApiResponseMessage' + '400': + description: Bad request provided + schema: + $ref: '#/definitions/ApiResponseMessage' + '401': + description: Unauthorized request + schema: + $ref: '#/definitions/ApiResponseMessage' + '503': + description: Service Unavailable + schema: + $ref: '#/definitions/ApiResponseMessage' + /eventListener/v5/eventBatch: + post: + security: + - basicAuth: [] + summary: '' + description: uri for posting VES batch event objects + operationId: veseventbatchPut + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/VES5Request' + responses: + '200': + description: VES Event Accepted. + schema: + $ref: '#/definitions/ApiResponseMessage' + '400': + description: Bad request provided + schema: + $ref: '#/definitions/ApiResponseMessage' + '401': + description: Unauthorized request + schema: + $ref: '#/definitions/ApiResponseMessage' + '503': + description: Service Unavailable + schema: + $ref: '#/definitions/ApiResponseMessage' + /healthcheck: + get: + responses: + '200': + description: healthcheck successful +definitions: + ApiResponseMessage: + type: object + properties: + code: + type: integer + format: int32 + type: + type: string + message: + type: string + VES5Request: + type: object + properties: + event: + $ref: '#/definitions/event' + codecsInUse: + description: number of times an identified codec was used over the measurementInterval + type: object + properties: + codecIdentifier: + type: string + numberInUse: + type: integer + required: + - codecIdentifier + - numberInUse + command: + description: command from an event collector toward an event source + type: object + properties: + commandType: + type: string + enum: + - heartbeatIntervalChange + - measurementIntervalChange + - provideThrottlingState + - throttlingSpecification + eventDomainThrottleSpecification: + $ref: '#/definitions/eventDomainThrottleSpecification' + heartbeatInterval: + type: integer + measurementInterval: + type: integer + required: + - commandType + commonEventHeader: + description: fields common to all events + type: object + properties: + domain: + description: the eventing domain associated with the event + type: string + enum: + - fault + - heartbeat + - measurementsForVfScaling + - mobileFlow + - other + - sipSignaling + - stateChange + - syslog + - thresholdCrossingAlert + - voiceQuality + eventId: + description: event key that is unique to the event source + type: string + eventName: + description: unique event name + type: string + eventType: + description: 'for example - applicationVnf, guestOS, hostOS, platform' + type: string + internalHeaderFields: + $ref: '#/definitions/internalHeaderFields' + lastEpochMicrosec: + description: >- + the latest unix time aka epoch time associated with the event from any + component--as microseconds elapsed since 1 Jan 1970 not including leap + seconds + type: number + nfcNamingCode: + description: >- + 3 character network function component type, aligned with vfc naming + standards + type: string + nfNamingCode: + description: '4 character network function type, aligned with vnf naming standards' + type: string + priority: + description: processing priority + type: string + enum: + - High + - Medium + - Normal + - Low + reportingEntityId: + description: >- + UUID identifying the entity reporting the event, for example an OAM + VM; must be populated by the ATT enrichment process + type: string + reportingEntityName: + description: >- + name of the entity reporting the event, for example, an EMS name; may + be the same as sourceName + type: string + sequence: + description: >- + ordering of events communicated by an event source instance or 0 if + not needed + type: integer + sourceId: + description: >- + UUID identifying the entity experiencing the event issue; must be + populated by the ATT enrichment process + type: string + sourceName: + description: name of the entity experiencing the event issue + type: string + startEpochMicrosec: + description: >- + the earliest unix time aka epoch time associated with the event from + any component--as microseconds elapsed since 1 Jan 1970 not including + leap seconds + type: number + version: + description: version of the event header + type: number + required: + - domain + - eventId + - eventName + - lastEpochMicrosec + - priority + - reportingEntityName + - sequence + - sourceName + - startEpochMicrosec + - version + counter: + description: performance counter + type: object + properties: + criticality: + type: string + enum: + - CRIT + - MAJ + name: + type: string + thresholdCrossed: + type: string + value: + type: string + required: + - criticality + - name + - thresholdCrossed + - value + cpuUsage: + description: usage of an identified CPU + type: object + properties: + cpuIdentifier: + description: cpu identifer + type: string + cpuIdle: + description: percentage of CPU time spent in the idle task + type: number + cpuUsageInterrupt: + description: percentage of time spent servicing interrupts + type: number + cpuUsageNice: + description: >- + percentage of time spent running user space processes that have been + niced + type: number + cpuUsageSoftIrq: + description: percentage of time spent handling soft irq interrupts + type: number + cpuUsageSteal: + description: >- + percentage of time spent in involuntary wait which is neither user, + system or idle time and is effectively time that went missing + type: number + cpuUsageSystem: + description: percentage of time spent on system tasks running the kernel + type: number + cpuUsageUser: + description: percentage of time spent running un-niced user space processes + type: number + cpuWait: + description: percentage of CPU time spent waiting for I/O operations to complete + type: number + percentUsage: + description: >- + aggregate cpu usage of the virtual machine on which the VNFC reporting + the event is running + type: number + required: + - cpuIdentifier + - percentUsage + diskUsage: + description: usage of an identified disk + type: object + properties: + diskIdentifier: + description: disk identifier + type: string + diskIoTimeAvg: + description: >- + milliseconds spent doing input/output operations over 1 sec; treat + this metric as a device load percentage where 1000ms matches 100% + load; provide the average over the measurement interval + type: number + diskIoTimeLast: + description: >- + milliseconds spent doing input/output operations over 1 sec; treat + this metric as a device load percentage where 1000ms matches 100% + load; provide the last value measurement within the measurement + interval + type: number + diskIoTimeMax: + description: >- + milliseconds spent doing input/output operations over 1 sec; treat + this metric as a device load percentage where 1000ms matches 100% + load; provide the maximum value measurement within the measurement + interval + type: number + diskIoTimeMin: + description: >- + milliseconds spent doing input/output operations over 1 sec; treat + this metric as a device load percentage where 1000ms matches 100% + load; provide the minimum value measurement within the measurement + interval + type: number + diskMergedReadAvg: + description: >- + number of logical read operations that were merged into physical read + operations, e.g., two logical reads were served by one physical disk + access; provide the average measurement within the measurement + interval + type: number + diskMergedReadLast: + description: >- + number of logical read operations that were merged into physical read + operations, e.g., two logical reads were served by one physical disk + access; provide the last value measurement within the measurement + interval + type: number + diskMergedReadMax: + description: >- + number of logical read operations that were merged into physical read + operations, e.g., two logical reads were served by one physical disk + access; provide the maximum value measurement within the measurement + interval + type: number + diskMergedReadMin: + description: >- + number of logical read operations that were merged into physical read + operations, e.g., two logical reads were served by one physical disk + access; provide the minimum value measurement within the measurement + interval + type: number + diskMergedWriteAvg: + description: >- + number of logical write operations that were merged into physical + write operations, e.g., two logical writes were served by one physical + disk access; provide the average measurement within the measurement + interval + type: number + diskMergedWriteLast: + description: >- + number of logical write operations that were merged into physical + write operations, e.g., two logical writes were served by one physical + disk access; provide the last value measurement within the measurement + interval + type: number + diskMergedWriteMax: + description: >- + number of logical write operations that were merged into physical + write operations, e.g., two logical writes were served by one physical + disk access; provide the maximum value measurement within the + measurement interval + type: number + diskMergedWriteMin: + description: >- + number of logical write operations that were merged into physical + write operations, e.g., two logical writes were served by one physical + disk access; provide the minimum value measurement within the + measurement interval + type: number + diskOctetsReadAvg: + description: >- + number of octets per second read from a disk or partition; provide the + average measurement within the measurement interval + type: number + diskOctetsReadLast: + description: >- + number of octets per second read from a disk or partition; provide the + last measurement within the measurement interval + type: number + diskOctetsReadMax: + description: >- + number of octets per second read from a disk or partition; provide the + maximum measurement within the measurement interval + type: number + diskOctetsReadMin: + description: >- + number of octets per second read from a disk or partition; provide the + minimum measurement within the measurement interval + type: number + diskOctetsWriteAvg: + description: >- + number of octets per second written to a disk or partition; provide + the average measurement within the measurement interval + type: number + diskOctetsWriteLast: + description: >- + number of octets per second written to a disk or partition; provide + the last measurement within the measurement interval + type: number + diskOctetsWriteMax: + description: >- + number of octets per second written to a disk or partition; provide + the maximum measurement within the measurement interval + type: number + diskOctetsWriteMin: + description: >- + number of octets per second written to a disk or partition; provide + the minimum measurement within the measurement interval + type: number + diskOpsReadAvg: + description: >- + number of read operations per second issued to the disk; provide the + average measurement within the measurement interval + type: number + diskOpsReadLast: + description: >- + number of read operations per second issued to the disk; provide the + last measurement within the measurement interval + type: number + diskOpsReadMax: + description: >- + number of read operations per second issued to the disk; provide the + maximum measurement within the measurement interval + type: number + diskOpsReadMin: + description: >- + number of read operations per second issued to the disk; provide the + minimum measurement within the measurement interval + type: number + diskOpsWriteAvg: + description: >- + number of write operations per second issued to the disk; provide the + average measurement within the measurement interval + type: number + diskOpsWriteLast: + description: >- + number of write operations per second issued to the disk; provide the + last measurement within the measurement interval + type: number + diskOpsWriteMax: + description: >- + number of write operations per second issued to the disk; provide the + maximum measurement within the measurement interval + type: number + diskOpsWriteMin: + description: >- + number of write operations per second issued to the disk; provide the + minimum measurement within the measurement interval + type: number + diskPendingOperationsAvg: + description: >- + queue size of pending I/O operations per second; provide the average + measurement within the measurement interval + type: number + diskPendingOperationsLast: + description: >- + queue size of pending I/O operations per second; provide the last + measurement within the measurement interval + type: number + diskPendingOperationsMax: + description: >- + queue size of pending I/O operations per second; provide the maximum + measurement within the measurement interval + type: number + diskPendingOperationsMin: + description: >- + queue size of pending I/O operations per second; provide the minimum + measurement within the measurement interval + type: number + diskTimeReadAvg: + description: >- + milliseconds a read operation took to complete; provide the average + measurement within the measurement interval + type: number + diskTimeReadLast: + description: >- + milliseconds a read operation took to complete; provide the last + measurement within the measurement interval + type: number + diskTimeReadMax: + description: >- + milliseconds a read operation took to complete; provide the maximum + measurement within the measurement interval + type: number + diskTimeReadMin: + description: >- + milliseconds a read operation took to complete; provide the minimum + measurement within the measurement interval + type: number + diskTimeWriteAvg: + description: >- + milliseconds a write operation took to complete; provide the average + measurement within the measurement interval + type: number + diskTimeWriteLast: + description: >- + milliseconds a write operation took to complete; provide the last + measurement within the measurement interval + type: number + diskTimeWriteMax: + description: >- + milliseconds a write operation took to complete; provide the maximum + measurement within the measurement interval + type: number + diskTimeWriteMin: + description: >- + milliseconds a write operation took to complete; provide the minimum + measurement within the measurement interval + type: number + required: + - diskIdentifier + endOfCallVqmSummaries: + description: provides end of call voice quality metrics + type: object + properties: + adjacencyName: + description: ' adjacency name' + type: string + endpointDescription: + description: Either Caller or Callee + type: string + enum: + - Caller + - Callee + endpointJitter: + description: '' + type: number + endpointRtpOctetsDiscarded: + description: '' + type: number + endpointRtpOctetsReceived: + description: '' + type: number + endpointRtpOctetsSent: + description: '' + type: number + endpointRtpPacketsDiscarded: + description: '' + type: number + endpointRtpPacketsReceived: + description: '' + type: number + endpointRtpPacketsSent: + description: '' + type: number + localJitter: + description: '' + type: number + localRtpOctetsDiscarded: + description: '' + type: number + localRtpOctetsReceived: + description: '' + type: number + localRtpOctetsSent: + description: '' + type: number + localRtpPacketsDiscarded: + description: '' + type: number + localRtpPacketsReceived: + description: '' + type: number + localRtpPacketsSent: + description: '' + type: number + mosCqe: + description: 1-5 1dp + type: number + packetsLost: + description: '' + type: number + packetLossPercent: + description: >- + Calculated percentage packet loss based on Endpoint RTP packets lost + (as reported in RTCP) and Local RTP packets sent. Direction is based + on Endpoint description (Caller, Callee). Decimal (2 dp) + type: number + rFactor: + description: 0-100 + type: number + roundTripDelay: + description: millisecs + type: number + required: + - adjacencyName + - endpointDescription + event: + description: the root level of the common event format + type: object + properties: + commonEventHeader: + $ref: '#/definitions/commonEventHeader' + faultFields: + $ref: '#/definitions/faultFields' + heartbeatFields: + $ref: '#/definitions/heartbeatFields' + measurementsForVfScalingFields: + $ref: '#/definitions/measurementsForVfScalingFields' + mobileFlowFields: + $ref: '#/definitions/mobileFlowFields' + otherFields: + $ref: '#/definitions/otherFields' + sipSignalingFields: + $ref: '#/definitions/sipSignalingFields' + stateChangeFields: + $ref: '#/definitions/stateChangeFields' + syslogFields: + $ref: '#/definitions/syslogFields' + thresholdCrossingAlertFields: + $ref: '#/definitions/thresholdCrossingAlertFields' + voiceQualityFields: + $ref: '#/definitions/voiceQualityFields' + required: + - commonEventHeader + eventDomainThrottleSpecification: + description: specification of what information to suppress within an event domain + type: object + properties: + eventDomain: + description: Event domain enum from the commonEventHeader domain field + type: string + suppressedFieldNames: + description: >- + List of optional field names in the event block that should not be + sent to the Event Listener + type: array + items: + type: string + suppressedNvPairsList: + description: >- + Optional list of specific NvPairsNames to suppress within a given + Name-Value Field + type: array + items: + $ref: '#/definitions/suppressedNvPairs' + required: + - eventDomain + eventDomainThrottleSpecificationList: + description: array of eventDomainThrottleSpecifications + type: array + items: + $ref: '#/definitions/eventDomainThrottleSpecification' + minItems: 0 + eventList: + description: array of events + type: array + items: + $ref: '#/definitions/event' + faultFields: + description: fields specific to fault events + type: object + properties: + alarmAdditionalInformation: + description: additional alarm information + type: array + items: + $ref: '#/definitions/field' + alarmCondition: + description: alarm condition reported by the device + type: string + alarmInterfaceA: + description: >- + card, port, channel or interface name of the device generating the + alarm + type: string + eventCategory: + description: >- + Event category, for example: license, link, routing, security, + signaling + type: string + eventSeverity: + description: event severity + type: string + enum: + - CRITICAL + - MAJOR + - MINOR + - WARNING + - NORMAL + eventSourceType: + description: >- + type of event source; examples: card, host, other, port, + portThreshold, router, slotThreshold, switch, virtualMachine, + virtualNetworkFunction + type: string + faultFieldsVersion: + description: version of the faultFields block + type: number + specificProblem: + description: short description of the alarm or problem + type: string + vfStatus: + description: virtual function status enumeration + type: string + enum: + - Active + - Idle + - Preparing to terminate + - Ready to terminate + - Requesting termination + required: + - alarmCondition + - eventSeverity + - eventSourceType + - faultFieldsVersion + - specificProblem + - vfStatus + featuresInUse: + description: >- + number of times an identified feature was used over the + measurementInterval + type: object + properties: + featureIdentifier: + type: string + featureUtilization: + type: integer + required: + - featureIdentifier + - featureUtilization + field: + description: name value pair + type: object + properties: + name: + type: string + value: + type: string + required: + - name + - value + filesystemUsage: + description: >- + disk usage of an identified virtual machine in gigabytes and/or gigabytes + per second + type: object + properties: + blockConfigured: + type: number + blockIops: + type: number + blockUsed: + type: number + ephemeralConfigured: + type: number + ephemeralIops: + type: number + ephemeralUsed: + type: number + filesystemName: + type: string + required: + - blockConfigured + - blockIops + - blockUsed + - ephemeralConfigured + - ephemeralIops + - ephemeralUsed + - filesystemName + gtpPerFlowMetrics: + description: Mobility GTP Protocol per flow metrics + type: object + properties: + avgBitErrorRate: + description: average bit error rate + type: number + avgPacketDelayVariation: + description: >- + Average packet delay variation or jitter in milliseconds for received + packets: Average difference between the packet timestamp and time + received for all pairs of consecutive packets + type: number + avgPacketLatency: + description: average delivery latency + type: number + avgReceiveThroughput: + description: average receive throughput + type: number + avgTransmitThroughput: + description: average transmit throughput + type: number + durConnectionFailedStatus: + description: >- + duration of failed state in milliseconds, computed as the cumulative + time between a failed echo request and the next following successful + error request, over this reporting interval + type: number + durTunnelFailedStatus: + description: >- + Duration of errored state, computed as the cumulative time between a + tunnel error indicator and the next following non-errored indicator, + over this reporting interval + type: number + flowActivatedBy: + description: Endpoint activating the flow + type: string + flowActivationEpoch: + description: >- + Time the connection is activated in the flow (connection) being + reported on, or transmission time of the first packet if activation + time is not available + type: number + flowActivationMicrosec: + description: Integer microseconds for the start of the flow connection + type: number + flowActivationTime: + description: >- + time the connection is activated in the flow being reported on, or + transmission time of the first packet if activation time is not + available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 + -0800 + type: string + flowDeactivatedBy: + description: Endpoint deactivating the flow + type: string + flowDeactivationEpoch: + description: >- + Time for the start of the flow connection, in integer UTC epoch time + aka UNIX time + type: number + flowDeactivationMicrosec: + description: Integer microseconds for the start of the flow connection + type: number + flowDeactivationTime: + description: >- + Transmission time of the first packet in the flow connection being + reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 + -0800 + type: string + flowStatus: + description: >- + connection status at reporting time as a working / inactive / failed + indicator value + type: string + gtpConnectionStatus: + description: Current connection state at reporting time + type: string + gtpTunnelStatus: + description: Current tunnel state at reporting time + type: string + ipTosCountList: + description: >- + array of key: value pairs where the keys are drawn from the IP + Type-of-Service identifiers which range from '0' to '255', and the + values are the count of packets that had those ToS identifiers in the + flow + type: array + items: + type: array + items: + type: string + type: number + ipTosList: + description: >- + Array of unique IP Type-of-Service values observed in the flow where + values range from '0' to '255' + type: array + items: + type: string + largePacketRtt: + description: large packet round trip time + type: number + largePacketThreshold: + description: large packet threshold being applied + type: number + maxPacketDelayVariation: + description: >- + Maximum packet delay variation or jitter in milliseconds for received + packets: Maximum of the difference between the packet timestamp and + time received for all pairs of consecutive packets + type: number + maxReceiveBitRate: + description: maximum receive bit rate + type: number + maxTransmitBitRate: + description: maximum transmit bit rate + type: number + mobileQciCosCountList: + description: >- + array of key: value pairs where the keys are drawn from LTE QCI or + UMTS class of service strings, and the values are the count of packets + that had those strings in the flow + type: array + items: + type: array + items: + type: string + type: number + mobileQciCosList: + description: >- + Array of unique LTE QCI or UMTS class-of-service values observed in + the flow + type: array + items: + type: string + numActivationFailures: + description: >- + Number of failed activation requests, as observed by the reporting + node + type: number + numBitErrors: + description: number of errored bits + type: number + numBytesReceived: + description: 'number of bytes received, including retransmissions' + type: number + numBytesTransmitted: + description: 'number of bytes transmitted, including retransmissions' + type: number + numDroppedPackets: + description: number of received packets dropped due to errors per virtual interface + type: number + numGtpEchoFailures: + description: >- + Number of Echo request path failures where failed paths are defined in + 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 + type: number + numGtpTunnelErrors: + description: >- + Number of tunnel error indications where errors are defined in 3GPP TS + 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 + type: number + numHttpErrors: + description: Http error count + type: number + numL7BytesReceived: + description: 'number of tunneled layer 7 bytes received, including retransmissions' + type: number + numL7BytesTransmitted: + description: >- + number of tunneled layer 7 bytes transmitted, excluding + retransmissions + type: number + numLostPackets: + description: number of lost packets + type: number + numOutOfOrderPackets: + description: number of out-of-order packets + type: number + numPacketErrors: + description: number of errored packets + type: number + numPacketsReceivedExclRetrans: + description: 'number of packets received, excluding retransmission' + type: number + numPacketsReceivedInclRetrans: + description: 'number of packets received, including retransmission' + type: number + numPacketsTransmittedInclRetrans: + description: 'number of packets transmitted, including retransmissions' + type: number + numRetries: + description: number of packet retries + type: number + numTimeouts: + description: number of packet timeouts + type: number + numTunneledL7BytesReceived: + description: 'number of tunneled layer 7 bytes received, excluding retransmissions' + type: number + roundTripTime: + description: round trip time + type: number + tcpFlagCountList: + description: >- + array of key: value pairs where the keys are drawn from TCP Flags and + the values are the count of packets that had that TCP Flag in the flow + type: array + items: + type: array + items: + type: string + type: number + tcpFlagList: + description: Array of unique TCP Flags observed in the flow + type: array + items: + type: string + timeToFirstByte: + description: >- + Time in milliseconds between the connection activation and first byte + received + type: number + required: + - avgBitErrorRate + - avgPacketDelayVariation + - avgPacketLatency + - avgReceiveThroughput + - avgTransmitThroughput + - flowActivationEpoch + - flowActivationMicrosec + - flowDeactivationEpoch + - flowDeactivationMicrosec + - flowDeactivationTime + - flowStatus + - maxPacketDelayVariation + - numActivationFailures + - numBitErrors + - numBytesReceived + - numBytesTransmitted + - numDroppedPackets + - numL7BytesReceived + - numL7BytesTransmitted + - numLostPackets + - numOutOfOrderPackets + - numPacketErrors + - numPacketsReceivedExclRetrans + - numPacketsReceivedInclRetrans + - numPacketsTransmittedInclRetrans + - numRetries + - numTimeouts + - numTunneledL7BytesReceived + - roundTripTime + - timeToFirstByte + heartbeatFields: + description: optional field block for fields specific to heartbeat events + type: object + properties: + additionalFields: + description: additional heartbeat fields if needed + type: array + items: + $ref: '#/definitions/field' + heartbeatFieldsVersion: + description: version of the heartbeatFields block + type: number + heartbeatInterval: + description: current heartbeat interval in seconds + type: integer + required: + - heartbeatFieldsVersion + - heartbeatInterval + internalHeaderFields: + description: >- + enrichment fields for internal VES Event Listener service use only, not + supplied by event sources + type: object + jsonObject: + description: >- + json object schema, name and other meta-information along with one or more + object instances + type: object + properties: + objectInstances: + description: one or more instances of the jsonObject + type: array + items: + $ref: '#/definitions/jsonObjectInstance' + objectName: + description: name of the JSON Object + type: string + objectSchema: + description: json schema for the object + type: string + objectSchemaUrl: + description: Url to the json schema for the object + type: string + nfSubscribedObjectName: + description: name of the object associated with the nfSubscriptonId + type: string + nfSubscriptionId: + description: >- + identifies an openConfig telemetry subscription on a network function, + which configures the network function to send complex object data + associated with the jsonObject + type: string + required: + - objectInstances + - objectName + jsonObjectInstance: + description: >- + meta-information about an instance of a jsonObject along with the actual + object instance + type: object + properties: + objectInstance: + description: an instance conforming to the jsonObject schema + type: object + objectInstanceEpochMicrosec: + description: >- + the unix time aka epoch time associated with this objectInstance--as + microseconds elapsed since 1 Jan 1970 not including leap seconds + type: number + objectKeys: + description: >- + an ordered set of keys that identifies this particular instance of + jsonObject + type: array + items: + $ref: '#/definitions/key' + required: + - objectInstance + key: + description: >- + tuple which provides the name of a key along with its value and relative + order + type: object + properties: + keyName: + description: name of the key + type: string + keyOrder: + description: relative sequence or order of the key with respect to other keys + type: integer + keyValue: + description: value of the key + type: string + required: + - keyName + latencyBucketMeasure: + description: number of counts falling within a defined latency bucket + type: object + properties: + countsInTheBucket: + type: number + highEndOfLatencyBucket: + type: number + lowEndOfLatencyBucket: + type: number + required: + - countsInTheBucket + measurementsForVfScalingFields: + description: measurementsForVfScaling fields + type: object + properties: + additionalFields: + description: additional name-value-pair fields + type: array + items: + $ref: '#/definitions/field' + additionalMeasurements: + description: array of named name-value-pair arrays + type: array + items: + $ref: '#/definitions/namedArrayOfFields' + additionalObjects: + description: >- + array of JSON objects described by name, schema and other + meta-information + type: array + items: + $ref: '#/definitions/jsonObject' + codecUsageArray: + description: array of codecs in use + type: array + items: + $ref: '#/definitions/codecsInUse' + concurrentSessions: + description: >- + peak concurrent sessions for the VM or VNF over the + measurementInterval + type: integer + configuredEntities: + description: >- + over the measurementInterval, peak total number of: users, + subscribers, devices, adjacencies, etc., for the VM, or subscribers, + devices, etc., for the VNF + type: integer + cpuUsageArray: + description: usage of an array of CPUs + type: array + items: + $ref: '#/definitions/cpuUsage' + diskUsageArray: + description: usage of an array of disks + type: array + items: + $ref: '#/definitions/diskUsage' + featureUsageArray: + description: array of features in use + type: array + items: + $ref: '#/definitions/featuresInUse' + filesystemUsageArray: + description: >- + filesystem usage of the VM on which the VNFC reporting the event is + running + type: array + items: + $ref: '#/definitions/filesystemUsage' + latencyDistribution: + description: >- + array of integers representing counts of requests whose latency in + milliseconds falls within per-VNF configured ranges + type: array + items: + $ref: '#/definitions/latencyBucketMeasure' + meanRequestLatency: + description: >- + mean seconds required to respond to each request for the VM on which + the VNFC reporting the event is running + type: number + measurementInterval: + description: interval over which measurements are being reported in seconds + type: number + measurementsForVfScalingVersion: + description: version of the measurementsForVfScaling block + type: number + memoryUsageArray: + description: memory usage of an array of VMs + type: array + items: + $ref: '#/definitions/memoryUsage' + numberOfMediaPortsInUse: + description: number of media ports in use + type: integer + requestRate: + description: >- + peak rate of service requests per second to the VNF over the + measurementInterval + type: number + vnfcScalingMetric: + description: represents busy-ness of the VNF from 0 to 100 as reported by the VNFC + type: integer + vNicPerformanceArray: + description: usage of an array of virtual network interface cards + type: array + items: + $ref: '#/definitions/vNicPerformance' + required: + - measurementInterval + - measurementsForVfScalingVersion + memoryUsage: + description: memory usage of an identified virtual machine + type: object + properties: + memoryBuffered: + description: kibibytes of temporary storage for raw disk blocks + type: number + memoryCached: + description: kibibytes of memory used for cache + type: number + memoryConfigured: + description: >- + kibibytes of memory configured in the virtual machine on which the + VNFC reporting the event is running + type: number + memoryFree: + description: kibibytes of physical RAM left unused by the system + type: number + memorySlabRecl: + description: >- + the part of the slab that can be reclaimed such as caches measured in + kibibytes + type: number + memorySlabUnrecl: + description: >- + the part of the slab that cannot be reclaimed even when lacking memory + measured in kibibytes + type: number + memoryUsed: + description: >- + total memory minus the sum of free, buffered, cached and slab memory + measured in kibibytes + type: number + vmIdentifier: + description: virtual machine identifier associated with the memory metrics + type: string + required: + - memoryFree + - memoryUsed + - vmIdentifier + mobileFlowFields: + description: mobileFlow fields + type: object + properties: + additionalFields: + description: additional mobileFlow fields if needed + type: array + items: + $ref: '#/definitions/field' + applicationType: + description: Application type inferred + type: string + appProtocolType: + description: application protocol + type: string + appProtocolVersion: + description: application protocol version + type: string + cid: + description: cell id + type: string + connectionType: + description: 'Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc' + type: string + ecgi: + description: Evolved Cell Global Id + type: string + flowDirection: + description: >- + Flow direction, indicating if the reporting node is the source of the + flow or destination for the flow + type: string + gtpPerFlowMetrics: + $ref: '#/definitions/gtpPerFlowMetrics' + gtpProtocolType: + description: GTP protocol + type: string + gtpVersion: + description: GTP protocol version + type: string + httpHeader: + description: 'HTTP request header, if the flow connects to a node referenced by HTTP' + type: string + imei: + description: >- + IMEI for the subscriber UE used in this flow, if the flow connects to + a mobile device + type: string + imsi: + description: >- + IMSI for the subscriber UE used in this flow, if the flow connects to + a mobile device + type: string + ipProtocolType: + description: 'IP protocol type e.g., TCP, UDP, RTP...' + type: string + ipVersion: + description: 'IP protocol version e.g., IPv4, IPv6' + type: string + lac: + description: location area code + type: string + mcc: + description: mobile country code + type: string + mnc: + description: mobile network code + type: string + mobileFlowFieldsVersion: + description: version of the mobileFlowFields block + type: number + msisdn: + description: >- + MSISDN for the subscriber UE used in this flow, as an integer, if the + flow connects to a mobile device + type: string + otherEndpointIpAddress: + description: >- + IP address for the other endpoint, as used for the flow being reported + on + type: string + otherEndpointPort: + description: >- + IP Port for the reporting entity, as used for the flow being reported + on + type: integer + otherFunctionalRole: + description: >- + Functional role of the other endpoint for the flow being reported on + e.g., MME, S-GW, P-GW, PCRF... + type: string + rac: + description: routing area code + type: string + radioAccessTechnology: + description: 'Radio Access Technology e.g., 2G, 3G, LTE' + type: string + reportingEndpointIpAddr: + description: >- + IP address for the reporting entity, as used for the flow being + reported on + type: string + reportingEndpointPort: + description: >- + IP port for the reporting entity, as used for the flow being reported + on + type: integer + sac: + description: service area code + type: string + samplingAlgorithm: + description: >- + Integer identifier for the sampling algorithm or rule being applied in + calculating the flow metrics if metrics are calculated based on a + sample of packets, or 0 if no sampling is applied + type: integer + tac: + description: transport area code + type: string + tunnelId: + description: tunnel identifier + type: string + vlanId: + description: VLAN identifier used by this flow + type: string + required: + - flowDirection + - gtpPerFlowMetrics + - ipProtocolType + - ipVersion + - mobileFlowFieldsVersion + - otherEndpointIpAddress + - otherEndpointPort + - reportingEndpointIpAddr + - reportingEndpointPort + namedArrayOfFields: + description: an array of name value pairs along with a name for the array + type: object + properties: + name: + type: string + arrayOfFields: + description: array of name value pairs + type: array + items: + $ref: '#/definitions/field' + required: + - name + - arrayOfFields + otherFields: + description: >- + fields for events belonging to the 'other' domain of the commonEventHeader + domain enumeration + type: object + properties: + hashOfNameValuePairArrays: + description: array of named name-value-pair arrays + type: array + items: + $ref: '#/definitions/namedArrayOfFields' + jsonObjects: + description: >- + array of JSON objects described by name, schema and other + meta-information + type: array + items: + $ref: '#/definitions/jsonObject' + nameValuePairs: + description: array of name-value pairs + type: array + items: + $ref: '#/definitions/field' + otherFieldsVersion: + description: version of the otherFields block + type: number + required: + - otherFieldsVersion + requestError: + description: standard request error data structure + type: object + properties: + messageId: + description: >- + Unique message identifier of the format ABCnnnn where ABC is either + SVC for Service Exceptions or POL for Policy Exception + type: string + text: + description: >- + Message text, with replacement variables marked with %n, where n is an + index into the list of <variables> elements, starting at 1 + type: string + url: + description: >- + Hyperlink to a detailed error resource e.g., an HTML page for browser + user agents + type: string + variables: + description: >- + List of zero or more strings that represent the contents of the + variables used by the message text + type: string + required: + - messageId + - text + sipSignalingFields: + description: sip signaling fields + type: object + properties: + additionalInformation: + description: additional sip signaling fields if needed + type: array + items: + $ref: '#/definitions/field' + compressedSip: + description: the full SIP request/response including headers and bodies + type: string + correlator: + description: this is the same for all events on this call + type: string + localIpAddress: + description: IP address on VNF + type: string + localPort: + description: port on VNF + type: string + remoteIpAddress: + description: IP address of peer endpoint + type: string + remotePort: + description: port of peer endpoint + type: string + sipSignalingFieldsVersion: + description: version of the sipSignalingFields block + type: number + summarySip: + description: >- + the SIP Method or Response (INVITE, 200 OK, BYE, + etc) + type: string + vendorVnfNameFields: + $ref: '#/definitions/vendorVnfNameFields' + required: + - correlator + - localIpAddress + - localPort + - remoteIpAddress + - remotePort + - sipSignalingFieldsVersion + - vendorVnfNameFields + stateChangeFields: + description: stateChange fields + type: object + properties: + additionalFields: + description: additional stateChange fields if needed + type: array + items: + $ref: '#/definitions/field' + newState: + description: new state of the entity + type: string + enum: + - inService + - maintenance + - outOfService + oldState: + description: previous state of the entity + type: string + enum: + - inService + - maintenance + - outOfService + stateChangeFieldsVersion: + description: version of the stateChangeFields block + type: number + stateInterface: + description: card or port name of the entity that changed state + type: string + required: + - newState + - oldState + - stateChangeFieldsVersion + - stateInterface + suppressedNvPairs: + description: >- + List of specific NvPairsNames to suppress within a given Name-Value Field + for event Throttling + type: object + properties: + nvPairFieldName: + description: Name of the field within which are the nvpair names to suppress + type: string + suppressedNvPairNames: + description: Array of nvpair names to suppress within the nvpairFieldName + type: array + items: + type: string + required: + - nvPairFieldName + - suppressedNvPairNames + syslogFields: + description: sysLog fields + type: object + properties: + additionalFields: + description: >- + additional syslog fields if needed provided as name=value delimited by + a pipe | symbol, for example: 'name1=value1|name2=value2|' + type: string + eventSourceHost: + description: hostname of the device + type: string + eventSourceType: + description: >- + type of event source; examples: other, router, switch, host, card, + port, slotThreshold, portThreshold, virtualMachine, + virtualNetworkFunction + type: string + syslogFacility: + description: numeric code from 0 to 23 for facility--see table in documentation + type: integer + syslogFieldsVersion: + description: version of the syslogFields block + type: number + syslogMsg: + description: syslog message + type: string + syslogPri: + description: 0-192 combined severity and facility + type: integer + syslogProc: + description: identifies the application that originated the message + type: string + syslogProcId: + description: >- + a change in the value of this field indicates a discontinuity in + syslog reporting + type: number + syslogSData: + description: >- + syslog structured data consisting of a structured data Id followed by + a set of key value pairs + type: string + syslogSdId: + description: 0-32 char in format name@number for example ourSDID@32473 + type: string + syslogSev: + description: >- + numerical Code for severity derived from syslogPri as remaider of + syslogPri / 8 + type: string + enum: + - Alert + - Critical + - Debug + - Emergency + - Error + - Info + - Notice + - Warning + syslogTag: + description: >- + msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE + should be used when no other value can be provided + type: string + syslogVer: + description: >- + IANA assigned version of the syslog protocol specification - typically + 1 + type: number + required: + - eventSourceType + - syslogFieldsVersion + - syslogMsg + - syslogTag + thresholdCrossingAlertFields: + description: fields specific to threshold crossing alert events + type: object + properties: + additionalFields: + description: additional threshold crossing alert fields if needed + type: array + items: + $ref: '#/definitions/field' + additionalParameters: + description: performance counters + type: array + items: + $ref: '#/definitions/counter' + alertAction: + description: Event action + type: string + enum: + - CLEAR + - CONT + - SET + alertDescription: + description: Unique short alert description such as IF-SHUB-ERRDROP + type: string + alertType: + description: Event type + type: string + enum: + - CARD-ANOMALY + - ELEMENT-ANOMALY + - INTERFACE-ANOMALY + - SERVICE-ANOMALY + alertValue: + description: Calculated API value (if applicable) + type: string + associatedAlertIdList: + description: List of eventIds associated with the event being reported + type: array + items: + type: string + collectionTimestamp: + description: >- + Time when the performance collector picked up the data; with RFC 2822 + compliant format: Sat, 13 Mar 2010 11:29:05 -0800 + type: string + dataCollector: + description: Specific performance collector instance used + type: string + elementType: + description: type of network element - internal ATT field + type: string + eventSeverity: + description: event severity or priority + type: string + enum: + - CRITICAL + - MAJOR + - MINOR + - WARNING + - NORMAL + eventStartTimestamp: + description: >- + Time closest to when the measurement was made; with RFC 2822 compliant + format: Sat, 13 Mar 2010 11:29:05 -0800 + type: string + interfaceName: + description: Physical or logical port or card (if applicable) + type: string + networkService: + description: network name - internal ATT field + type: string + possibleRootCause: + description: Reserved for future use + type: string + thresholdCrossingFieldsVersion: + description: version of the thresholdCrossingAlertFields block + type: number + required: + - additionalParameters + - alertAction + - alertDescription + - alertType + - collectionTimestamp + - eventSeverity + - eventStartTimestamp + - thresholdCrossingFieldsVersion + vendorVnfNameFields: + description: 'provides vendor, vnf and vfModule identifying information' + type: object + properties: + vendorName: + description: VNF vendor name + type: string + vfModuleName: + description: ASDC vfModuleName for the vfModule generating the event + type: string + vnfName: + description: ASDC modelName for the VNF generating the event + type: string + required: + - vendorName + vNicPerformance: + description: >- + describes the performance and errors of an identified virtual network + interface card + type: object + properties: + receivedBroadcastPacketsAccumulated: + description: >- + Cumulative count of broadcast packets received as read at the end of + the measurement interval + type: number + receivedBroadcastPacketsDelta: + description: Count of broadcast packets received within the measurement interval + type: number + receivedDiscardedPacketsAccumulated: + description: >- + Cumulative count of discarded packets received as read at the end of + the measurement interval + type: number + receivedDiscardedPacketsDelta: + description: Count of discarded packets received within the measurement interval + type: number + receivedErrorPacketsAccumulated: + description: >- + Cumulative count of error packets received as read at the end of the + measurement interval + type: number + receivedErrorPacketsDelta: + description: Count of error packets received within the measurement interval + type: number + receivedMulticastPacketsAccumulated: + description: >- + Cumulative count of multicast packets received as read at the end of + the measurement interval + type: number + receivedMulticastPacketsDelta: + description: Count of multicast packets received within the measurement interval + type: number + receivedOctetsAccumulated: + description: >- + Cumulative count of octets received as read at the end of the + measurement interval + type: number + receivedOctetsDelta: + description: Count of octets received within the measurement interval + type: number + receivedTotalPacketsAccumulated: + description: >- + Cumulative count of all packets received as read at the end of the + measurement interval + type: number + receivedTotalPacketsDelta: + description: Count of all packets received within the measurement interval + type: number + receivedUnicastPacketsAccumulated: + description: >- + Cumulative count of unicast packets received as read at the end of the + measurement interval + type: number + receivedUnicastPacketsDelta: + description: Count of unicast packets received within the measurement interval + type: number + transmittedBroadcastPacketsAccumulated: + description: >- + Cumulative count of broadcast packets transmitted as read at the end + of the measurement interval + type: number + transmittedBroadcastPacketsDelta: + description: Count of broadcast packets transmitted within the measurement interval + type: number + transmittedDiscardedPacketsAccumulated: + description: >- + Cumulative count of discarded packets transmitted as read at the end + of the measurement interval + type: number + transmittedDiscardedPacketsDelta: + description: Count of discarded packets transmitted within the measurement interval + type: number + transmittedErrorPacketsAccumulated: + description: >- + Cumulative count of error packets transmitted as read at the end of + the measurement interval + type: number + transmittedErrorPacketsDelta: + description: Count of error packets transmitted within the measurement interval + type: number + transmittedMulticastPacketsAccumulated: + description: >- + Cumulative count of multicast packets transmitted as read at the end + of the measurement interval + type: number + transmittedMulticastPacketsDelta: + description: Count of multicast packets transmitted within the measurement interval + type: number + transmittedOctetsAccumulated: + description: >- + Cumulative count of octets transmitted as read at the end of the + measurement interval + type: number + transmittedOctetsDelta: + description: Count of octets transmitted within the measurement interval + type: number + transmittedTotalPacketsAccumulated: + description: >- + Cumulative count of all packets transmitted as read at the end of the + measurement interval + type: number + transmittedTotalPacketsDelta: + description: Count of all packets transmitted within the measurement interval + type: number + transmittedUnicastPacketsAccumulated: + description: >- + Cumulative count of unicast packets transmitted as read at the end of + the measurement interval + type: number + transmittedUnicastPacketsDelta: + description: Count of unicast packets transmitted within the measurement interval + type: number + valuesAreSuspect: + description: >- + Indicates whether vNicPerformance values are likely inaccurate due to + counter overflow or other condtions + type: string + enum: + - 'true' + - 'false' + vNicIdentifier: + description: vNic identification + type: string + required: + - valuesAreSuspect + - vNicIdentifier + voiceQualityFields: + description: provides statistics related to customer facing voice products + type: object + properties: + additionalInformation: + description: additional voice quality fields if needed + type: array + items: + $ref: '#/definitions/field' + calleeSideCodec: + description: callee codec for the call + type: string + callerSideCodec: + description: caller codec for the call + type: string + correlator: + description: this is the same for all events on this call + type: string + endOfCallVqmSummaries: + $ref: '#/definitions/endOfCallVqmSummaries' + phoneNumber: + description: phone number associated with the correlator + type: string + midCallRtcp: + description: Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers + type: string + vendorVnfNameFields: + $ref: '#/definitions/vendorVnfNameFields' + voiceQualityFieldsVersion: + description: version of the voiceQualityFields block + type: number + required: + - calleeSideCodec + - callerSideCodec + - correlator + - midCallRtcp + - vendorVnfNameFields + - voiceQualityFieldsVersion diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst index 8daa0d3b..8014ed49 100644 --- a/docs/sections/architecture.rst +++ b/docs/sections/architecture.rst @@ -4,24 +4,52 @@ Architecture ============ -.. note:: - * This section is used to describe a software component from a high level - view of capability, common usage scenarios, and interactions with other - components required in the usage scenarios. - - * The architecture section is typically: provided in a platform-component - and sdk collections; and referenced from developer and user guides. - - * This note must be removed after content has been added. - Capabilities ------------ +Data Collection Analytics and Events (DCAE) is the data collection and analysis subsystem of ONAP. +Its functions include collection of FCAPs data from the network entitiess (VNFs, PNFs, etc), normalization and transportation of +data, analysis of data, and generations of ONAP events which can be received by other ONAP components such as Policy for +subsequent operations. + +DCAE consists of DCAE Platform components and DCAE Services components. The following list shows the details of what are included +in ONAP R1 + +- DCAE Platform + - Core Platform + - Cloudify Manager (VM) + - Consul service (VM cluster) + - Extended Platform + - Docker Host for containerized platform components (VM). It runs the following DCAE platform micro services (containers). + - Configuration Binding Servive + - CDAP Broker + - Deployment Handler + - Policy Handler + - Service Change Handler + - DCAE Inventory-API + - CDAP Analytics Platform for CDAP analytics applications (VM cluster) + - Docker Host for containerized service components (VM) + - PostgreSQL Database (VM) + + +- DCAE Services + - Collectors + - Virtual Event Streaming (VES) collector, containerized + - SNMP Trap collector, containerized + - Analytics + - Holmes correlation analytics, containerized + - Threshold Crosssing Analytics (TCA), CDAP analytics application Usage Scenarios --------------- +For ONPA R1 DCAE participates in all use cases. + +vDNS/vFW: VES collector, TCA analytics +vCPE: VES collector, TCA analytics +vVoLTE: VES collector, Holmes analytics Interactions ------------ + diff --git a/docs/sections/consumedapis.rst b/docs/sections/consumedapis.rst index c2af4c20..46229fd8 100644 --- a/docs/sections/consumedapis.rst +++ b/docs/sections/consumedapis.rst @@ -13,4 +13,9 @@ Consumed APIs * This note must be removed after content has been added. +DCAEGEN2 Components making following API calls into other ONAP components. +DMaaP Message Router +Policy +SDC +A&AI diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst index b1b8f41e..20e2f6c0 100644 --- a/docs/sections/offeredapis.rst +++ b/docs/sections/offeredapis.rst @@ -1,26 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Offered APIs -============ - -.. note:: - * This section is used to describe the external interfaces offered by a software component - - * This section is typically: provided for a platform-component and sdk; and - referenced in developer guides and api reference manuals. - - * This note must be removed after content has been added. - - - -Here are several examples: +DCAEGEN2 Components Offered APIs +================================== .. toctree:: :maxdepth: 1 :titlesonly: - apiexample/swaggerv2doc.rst - apiexample/swagger2markup.rst - apiexample/worddoc2rst.rst - apiexample/httpdomain.rst + apis/cdapbroker.rst + apis/config_binding.rst + apis/deploymenthandler.rst + apis/inventory_api.rst + apis/ves.rst |