diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/files/VESEventListener.rst | 2669 |
1 files changed, 2669 insertions, 0 deletions
diff --git a/docs/files/VESEventListener.rst b/docs/files/VESEventListener.rst new file mode 100644 index 0000000..5cff4db --- /dev/null +++ b/docs/files/VESEventListener.rst @@ -0,0 +1,2669 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property, All rights reserved +.. Copyright 2017 Huawei Technologies Co., Ltd. +============================= +Service: *VES Event Listener* +============================= + +.. contents:: Table of Contents + +Introduction +============ + +This document describes the RESTful interface for the VES (Virtual function Event Streaming) Event Listener. The VES Event Listener is capable of receiving any event sent in the VES Common Event Format. The Common Event Format is a JSON structure consisting of a required Common Event Header Block accompanied by zero or more event domain blocks. A JSON Schema of the VES Common Event Format is provided in Section 4 of this document. + +It should be understood that events are well structured packages of information, identified by an eventName, which are asynchronously communicated to subscribers who are interested in the eventName. Events can convey measurements, faults, syslogs, threshold crossing alerts and others types of information. Events are simply a way of communicating well-structured packages of information to one or more instances of an Event Listener service. + +This document describes a RESTful connectionless push event listener that is capable of receiving single events or batches of events in the Common Event Format. In future, additional documents may describe other transports which make use of persistent TCP connections for high volumes of streaming events. + +Event Registration +------------------ + +All events must be compliant with the common event format, but specific events identified by their eventNames, may require that certain fields, which are optional in the common event format, be present when they are published. For example, a specific eventName may require that specific name-value pairs be present in the extensible structures provided within the Common Event Format. + +Events are registered using an extensible YAML format (defined in a separate document), which specifies, for each eventName, the fields that are required, what field values may be sent, and any special handling that should be performed on those eventNames. + +Naming Standards for eventName +------------------------------ + +To prevent naming collisions, eventNames sent as part of the +commonEventHeader, should conform to the following naming convention designed to summarize the purpose and type of the event, and to ensure the uniqueness of the eventName: + + {DomainAbbreviation}\_{SdcModel or + ApplicationPlatform}\_{DescriptionOfInfoBeingConveyed} + +Domain abbreviations are derived from the 'domain' field in the +commonEventHeader, as specified below: +- 'Fault'for the fault domain +- 'Heartbeat'for the heartbeat domain +- 'Mfvs'for the measurementsForVfScaling domain +- 'MobileFlow'for the mobileFlow domain +- 'Other'for the other domain +- 'SipSignaling'for the sipSignaling domain +- 'StateChange'for the stateChange domain +- 'Syslog'for the syslog domain +- 'Tca'for the thresholdCrossingAlert domain +- 'voiceQuality'for the voiceQuality domain + +Sdc (the ONAP Service Design and Creation environment) defines and catalogs specific services, VNFs, VF modules and other entities, which are generically referred to as 'Sdc models'. The Sdc model that an event is associated with should be indicated in the second subfield within the eventName. If the event is not associated with an Sdc model but is instead being generated by an application platform like SO, then a string identifying the Application Platform may be used instead. In either case, all subfield names should be converted to camel case format (with no spaces, hyphens or underscores). + +The final subfield of the eventName name should describe, in a compact camel case format (with no spaces, hyphens or underscores), the specific information being conveyed by the event. In some cases, this final subfield will not be required (e.g., in the case of Heartbeats or in the case of an event source which, for a domain like syslog, defines only one eventName to support it): + +Examples of eventNames following the naming standards are provided below: + +- Fault\_MobileCallRecording\_PilotNumberPoolExhaustion +- Heartbeat\_vIsbcMmc +- Other\_WanBonding\_InstantiationPart1Complete +- Syslog\_vDbe +- Tca\_vDbe\_CpuThresholdExceeded +- Other\_SO\_InstantiationPhase1Complete + +Any questions about the naming of eventNames should be resolved as part of service and resource onboarding to the ONAP Service Design and Creation environment (i.e., Sdc). + +Support for Protocols Other Than HTTPS +-------------------------------------- + +This API specification describes an HTTPS RESTful interface using the JSON content-type. + +Alternative specifications may be provided in future using Websockets, which would establish a permanent TCP socket, or Apache Avro which provides a binary format over an RPC protocol to be defined. Both would leverage the JSON schema provided in this document. + +Versioning +---------- + +Three types of version numbers supported by this specification: +- The API specification itself is versioned. Going forward, the major number of the specification version will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the spec (e.g., a field name is added or text changes are made to the specification itself) will increment only the minor number. Note that the major number appears in REST resource URLs as v# (where '#'is the major number). + +- The JSON schema is versioned. Going forward, the major number of the JSON schema will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the schema (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number. + +- The field blocks are versioned. Field blocks include the commonEventHeader and the domain blocks (e.g., the faultFields block). Going forward, the major number of each field block will be incremented whenever any change to that block could break an existing client (e.g., a field name is deleted or changed). All other changes to that block (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number. + +Security +======== + +Event sources must identify themselves to the VES Event Listener. + +Event source credentials are passed using HTTP `Basic Authentication <http://tools.ietf.org/html/rfc2617>`__. + +Credentials must not be passed on the query string. Credentials must be sent in an Authorization header as follows: + +1. The username and password are formed into one string as "username:password" + +2. The resulting string is Base64 encoded to produce the encoded credential. + +3. The encoded credential is communicated in the header after the string "Authorization: Basic " + +Because the credentials are merely encoded but not encrypted, HTTPS (rather than HTTP) should be used. HTTPS will also encrypt and protect event contents. + +Examples are provided below. + +Sample Request and Response +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sample Request +^^^^^^^^^^^^^^ + ++---------------------------------------------------------------+ +| POST /eventListener/v5 HTTPS/1.1 | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| content-type: application/json | +| content-length: 12345 | +| { | +| "event": { | +| "commonEventHeader": { | +| "version": 3.0, | +| "domain": "heartbeat", | +| "eventName": "Heartbeat\_vIsbcMmc", | +| "eventId": "ab305d54-85b4-a31b-7db2fb6b9e546015", | +| "sequence": 0, | +| "priority": "Normal", | +| "reportingEntityId": "cc305d54-75b4-431badb2eb6b9e541234",| +| "reportingEntityName": "EricssonOamVf", | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| "sourceName": "ibcx0001vm002ssc001", | +| "nfNamingCode": "ibcx", | +| "nfcNamingCode": "ssc", | +| "startEpochMicrosec": 1413378172000000, | +| "lastEpochMicrosec": 1413378172000000 | +| } | +| } | +| } | ++---------------------------------------------------------------+ + +Sample Success Response +^^^^^^^^^^^^^^^^^^^^^^^ + ++--------------------------+ +| HTTPS/1.1 202 Accepted | ++--------------------------+ + +Resource Structure +================== + +REST resources are defined with respect to a ServerRoot: + + ServerRoot = /{optionalRoutingtPath} + +The resource structure is provided below: + + |image0| + +Figure 1 REST Resource Structure + +The {Domain} or FQDN above is typically provisioned into each +eventsource when it is instantiated. The {Port} above is typically 8443. + +Common Event Format +=================== + +A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow. + +Common Event Datatypes +---------------------- + +Command List Processing Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: command +^^^^^^^^^^^^^^^^^ + +The command datatype is used by an event collector to request changes in the behavior of an event source (for more information, see 6.1.3); it consists of the following fields: + ++-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=====================================+====================================+=============+=====================================================================================================+ +| commandType | string | Yes | Enumeration: 'heartbeatIntervalChange', 'measurementIntervalChange', | +| | | | | +| | | | 'provideThrottlingState', 'throttllingSpecification' | ++-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ +| eventDomainThrottle Specification | eventDomainThrottleSpecification | No | If commandType is 'throttlingSpecification', the fields to suppress within an event domain | ++-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ +| heartbeatInterval | integer | No | If commandType is 'heartbeatIntervalChange', the heartbeatInterval duration to use in seconds | ++-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ +| measurementInterval | integer | No | If commandType is 'measurementIntervalChange', the measurementInterval duration to use in seconds | ++-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ + +Datatype: commandList +^^^^^^^^^^^^^^^^^^^^^ + +The commandList datatype is an array of commands from an event collector toward an event source; it consists of the following fields: + ++---------------+---------------+-------------+-------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===============+===============+=============+===================================================================+ +| commandList | Command [ ] | Yes | List of commands from an event collector toward an event source | ++---------------+---------------+-------------+-------------------------------------------------------------------+ + +Datatype: eventDomainThrottleSpecification +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The eventDomainThrottleSpecification datatype specifies what fields to suppress within an event domain; it consists of the following fields common to all events: + ++-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=========================+=========================+=============+=================================================================================================+ +| eventDomain | string | Yes | Event domain enum from the commonEventHeader domain field | ++-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ +| suppressedFieldNames | string [ ] | No | List of optional field names in the event block that should not be sent to the Event Listener | ++-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ +| suppressedNvPairsList | suppressedNvPairs [ ] | No | Optional list of specific NvPairsNames to suppress within a given Name-Value Field | ++-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ + +Datatype: eventDomainThrottleSpecificationList +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The eventDomainThrottleSpecificationList datatype consists of the +following fields: + ++----------------------------------------+----------------------------------------+-------------+----------------------------------------------+ +| Field | Type | Required? | Description | ++========================================+========================================+=============+==============================================+ +| eventDomainThrottleSpecificationList | eventDomainThrottleSpecification [ ] | Yes | Array of eventDomainThrottleSpecifications | ++----------------------------------------+----------------------------------------+-------------+----------------------------------------------+ + +Datatype: eventThrottlingState +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The eventThrottlingState datatype reports the throttling in force at the event source; it consists of the following fields: + ++----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++========================================+========================================+=============+==============================================================================================================================+ +| eventThrottlingMode | string | Yes | Enumeration: 'normal', 'throttled' | ++----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ +| eventDomainThrottleSpecificationList | eventDomainThrottleSpecificationList | No | A list of eventDomainThrottleSpecifications currently in force at the event source, if the eventManagerMode is 'throttled' | ++----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: suppressedNvPairs +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The suppressedNvPairs datatype is a list of specific NvPairsNames to suppress within a given Name-Value Field (for event throttling); it consists of the following fields: + ++-------------------------+--------------+-------------+-------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=========================+==============+=============+===================================================================+ +| nvPairFieldName | string | Yes | Name of the field within which are the nvpair names to suppress | ++-------------------------+--------------+-------------+-------------------------------------------------------------------+ +| suppressedNvPairNames | string [ ] | Yes | Array of nvpair names to suppress (within the nvpairFieldName) | ++-------------------------+--------------+-------------+-------------------------------------------------------------------+ + +Common Event Datatypes +~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: event +^^^^^^^^^^^^^^^ + +The event datatype consists of the following fields which constitute the 'root level'of the common event format: + ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| Field | Type | Required? | Description | ++==================================+==================================+=============+======================================================+ +| commonEventHeader | commonEventHeader | Yes | Fields common to all events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| faultFields | faultFields | No | Fields specific to fault events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| heartbeatFields | heartbeatFields | No | Fields specific to heartbeat events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| measurementsForVfScalingFields | measurementsForVfScalingFields | No | Fields specific to measurementsForVfScaling events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| mobileFlowFields | mobileFlowFields | No | Fields specific to mobility flow events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| otherFields | otherFields | No | Fields specific to other types of events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| sipSignalingFields | sipSignalingFields | No | Fields specific to sipSignaling events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| stateChangeFields | stateChangeFields | No | Fields specific to state change events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| syslogFields | syslogFields | No | Fields specific to syslog events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| thresholdCrossingAlertFields | thresholdCrossingAlertFields | No | Fields specific to threshold crossing alert events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ +| voiceQualityFields | voiceQualityFields | No | Fields specific to voiceQuality events | ++----------------------------------+----------------------------------+-------------+------------------------------------------------------+ + +Datatype: eventList +^^^^^^^^^^^^^^^^^^^ + +The eventList datatype consists of the following fields: + ++-------------+-------------+-------------+-------------------+ +| Field | Type | Required? | Description | ++=============+=============+=============+===================+ +| eventList | event [ ] | Yes | Array of events | ++-------------+-------------+-------------+-------------------+ + +Datatype: field +^^^^^^^^^^^^^^^ + +The field datatype consists of the following fields: + ++---------+----------+-------------+----------------------------+ +| Field | Type | Required? | Description | ++=========+==========+=============+============================+ +| name | string | Yes | Name of the field | ++---------+----------+-------------+----------------------------+ +| value | string | Yes | Value of the named field | ++---------+----------+-------------+----------------------------+ + +Datatype: jsonObject +^^^^^^^^^^^^^^^^^^^^ + +The jsonObject datatype provides a json object schema, name and other meta-information along with one or more object instances that conform to the schema: + ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++==========================+==========================+=============+===========================================================================================================================================================================+ +| objectInstances | JsonObjectInstance [ ] | Yes | Contains one or more instances of the json object | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| objectName | string | Yes | Name of the json object | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| objectSchema | string | No | json schema for the object | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| objectSchemaUrl | string | No | URL to the json schema for the object | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| nfSubscribedObjectName | string | No | Name of the object associated with the nfSubscriptionId | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| nfSubscriptionId | string | No | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject | ++--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: jsonObjectInstance +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The jsonObjectInstance datatype provides meta-information about an +instance of a jsonObject along with the actual object instance: + ++-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===============================+===========+=============+===========================================================================================================================================+ +| objectInstance | object | Yes | Contains an instance conforming to the jsonObject schema | ++-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| objectInstanceEpochMicrosec | number | No | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds | ++-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| objectKeys | key [ ] | No | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy) | ++-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: key +^^^^^^^^^^^^^ + +The key datatype is a tuple which provides the name of a key along with +its value and relative order; it consists of the following fields: + ++------------+-----------+-------------+----------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++============+===========+=============+======================================================================+ +| keyName | string | Yes | Name of the key | ++------------+-----------+-------------+----------------------------------------------------------------------+ +| keyOrder | Integer | No | Relative sequence or order of the key (with respect to other keys) | ++------------+-----------+-------------+----------------------------------------------------------------------+ +| keyValue | string | No | Value of the key | ++------------+-----------+-------------+----------------------------------------------------------------------+ + +Datatype: namedArrayOfFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The namedArrayOfFields datatype is an array of name value pairs along with a name for the array; it consists of the following fields: + ++-----------------+-------------+-------------+------------------------------------------+ +| Field | Type | Required? | Description | ++=================+=============+=============+==========================================+ +| name | string | Yes | Name for the array of name-value pairs | ++-----------------+-------------+-------------+------------------------------------------+ +| arrayOfFields | field [ ] | Yes | Name-value pairs | ++-----------------+-------------+-------------+------------------------------------------+ + +Datatype: requestError +^^^^^^^^^^^^^^^^^^^^^^ + +The requestError datatype defines the standard request error data +structure: + ++-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=============+==========+=============+================================================================================================================================================================================================================================================================================================+ +| messageId | string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined. | ++-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| text | string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | ++-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| url | string | No | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents | ++-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| variables | string | No | List of zero or more strings that represent the contents of the variables used by the message text | ++-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: vendorVnfNameFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The vendorVnfNameFields provides vendor, vnf and vfModule identifying information: + ++----------------+----------+-------------+---------------------------------------------------------------+ +| Field | Type | Required? | Description | ++================+==========+=============+===============================================================+ +| vendorName | string | Yes | VNF vendor name | ++----------------+----------+-------------+---------------------------------------------------------------+ +| vfModuleName | string | No | The Sdc vfModuleName for the vfModule generating the event | ++----------------+----------+-------------+---------------------------------------------------------------+ +| vnfName | string | No | The Sdc modelName for the VNF generating the event | ++----------------+----------+-------------+---------------------------------------------------------------+ + +'Common Event Header'Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: commonEventHeader +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The commonEventHeader datatype consists of the following fields common to all events: + ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=========================+=========================+=============+================================================================================================================================================================================================================================================================================+ +| version | number | Yes | Version of the event header (currently: 3.0) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventName | string | Yes | Unique event name (see section 1 for more information) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventId | string | Yes | Event key that is unique to the event source | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventType | string | No | For example: 'applicationVnf', 'guestOS', 'hostOS', 'platform' | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| nfcNamingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf naming standards) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| sourceId | string | No | UUID identifying the entity experiencing the event issue (note: the AT&T internal enrichment process shall ensure that this field is populated) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| sourceName | string | Yes | Name of the entity experiencing the event issue | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| reportingEntityId | string | No | UUID identifying the entity reporting the event, for example an OAM VM (note: the AT&T internal enrichment process shall ensure that this field is populated) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| reportingEntityName | string | Yes | Name of the entity reporting the event, for example, an EMS name. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| priority | string | Yes | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| startEpochMicrosec | number | Yes | 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 | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| lastEpochMicrosec | number | Yes | 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 | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| internalHeader Fields | internalHeader Fields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener. | ++-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: internalHeaderFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener. +The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener: + +Technology Independent Datatypes +-------------------------------- + +'Fault'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: faultFields +^^^^^^^^^^^^^^^^^^^^^ + +The faultFields datatype consists of the following fields: + ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===============================+=============+=============+================================================================================================================================================================+ +| faultFieldsVersion | number | Yes | Version of the faultFields block (currently: 2.0) | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventSeverity | string | Yes | Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventSourceType | string | Yes | Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction' | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventCategory | string | No | Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| alarmCondition | string | Yes | Alarm condition reported by the device (e.g., 'tpLgCgiNotInConfig') | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| specificProblem | string | Yes | Short description of the alarm or problem (e.g., 'This event is sent when the LG is asked to perform a location for a CGI that is not in its configuration') | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vfStatus | string | Yes | Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| alarmInterfaceA | string | No | Card, port, channel or interface name of the device generating the alarm | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| alarmAdditional Information | field [ ] | No | Additional alarm information (note: for SNMP mapping to VES, for name use OID of varbind, for value use incoming data for that varbind) | ++-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +'Heartbeat'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: heartbeatFields +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The heartbeatFields datatype is an optional field block for fields specific to heartbeat events; it consists of the following fields: + ++--------------------------+-------------+-------------+---------------------------------------------------------+ +| Field | Type | Required? | Description | ++==========================+=============+=============+=========================================================+ +| heartbeatFieldsVersion | number | Yes | Version of the heartbeatFields block (currently: 1.0) | ++--------------------------+-------------+-------------+---------------------------------------------------------+ +| additionalFields | field [ ] | No | Additional expansion fields if needed | ++--------------------------+-------------+-------------+---------------------------------------------------------+ +| heartbeatInterval | Integer | Yes | Current heartbeatInterval in seconds | ++--------------------------+-------------+-------------+---------------------------------------------------------+ + + 'Measurements For VF Scaling'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: codecsInUse +^^^^^^^^^^^^^^^^^^^^^ + +The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval: + ++------------------+-----------+-------------+--------------------------------+ +| Field | Type | Required? | Description | ++==================+===========+=============+================================+ +| codecIdentifer | string | Yes | Description of the codec | ++------------------+-----------+-------------+--------------------------------+ +| numberInUse | integer | Yes | Number of such codecs in use | ++------------------+-----------+-------------+--------------------------------+ + +Datatype: cpuUsage +^^^^^^^^^^^^^^^^^^ + +The cpuUsage datatype defines the usage of an identifier CPU and +consists of the following fields: + ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=====================+==========+=============+=====================================================================================================================================+ +| cpuIdentifier | string | Yes | CPU Identifier | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuIdle | number | No | Percentage of CPU time spent in the idle task | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageInterrupt | number | No | Percentage of time spent servicing interrupts | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageNice | number | No | Percentage of time spent running user space processes that have been niced | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageSoftIrq | number | No | Percentage of time spent handling soft irq interrupts | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageSteal | number | No | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageSystem | number | No | Percentage of time spent on system tasks running the kernel | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageUser | number | No | Percentage of time spent running un-niced user space processes | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| cpuWait | number | No | Percentage of CPU time spent waiting for I/O operations to complete | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| percentUsage | number | Yes | Aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running | ++---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: diskUsage +^^^^^^^^^^^^^^^^^^^ + +The diskUsage datatype defines the usage of a disk and consists of the following fields: + ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=============================+==========+=============+===============================================================================================================================================================================================================================+ +| diskIdentifier | string | Yes | Disk Identifier | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskIoTimeAvg | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | number | No | 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 | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsRead Avg | number | No | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsRead | number | No | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval | +| | | | | +| Last | | | | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsRead Max | number | No | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsRead Min | number | No | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsWrite Avg | number | No | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsWrite Last | number | No | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsWriteMax | number | No | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOctetsWriteMin | number | No | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsReadAvg | number | No | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsReadLast | number | No | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsReadMax | number | No | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsReadMin | number | No | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsWriteAvg | number | No | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsWriteLast | number | No | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsWrite Max | number | No | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskOpsWriteMin | number | No | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskPendingOperationsAvg | number | No | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskPendingOperationsLast | number | No | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskPendingOperationsMax | number | No | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskPendingOperationsMin | number | No | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeReadAvg | number | No | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeRead Last | number | No | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeRead Max | number | No | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeRead Min | number | No | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeWrite Avg | number | No | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeWrite Last | number | No | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeWrite Max | number | No | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskTimeWrite Min | number | No | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval | ++-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: featuresInUse +^^^^^^^^^^^^^^^^^^^^^^^ + +The featuresInUse datatype consists of the following fields which +describe the number of times an identified feature was used over the measurementInterval: + ++----------------------+-----------+-------------+---------------------------------------------------+ +| Field | Type | Required? | Description | ++======================+===========+=============+===================================================+ +| featureIdentifer | string | Yes | Description of the feature | ++----------------------+-----------+-------------+---------------------------------------------------+ +| featureUtilization | integer | Yes | Number of times the identified feature was used | ++----------------------+-----------+-------------+---------------------------------------------------+ + +Datatype: filesystemUsage +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The filesystemUsage datatype consists of the following fields: + ++-----------------------+----------+-------------+--------------------------------------------------------+ +| Field | Type | Required? | Description | ++=======================+==========+=============+========================================================+ +| filesystemName | string | Yes | File system name | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| blockConfigured | number | Yes | Configured block storage capacity in GB | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| blockIops | number | Yes | Block storage input-output operations per second | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| blockUsed | number | Yes | Used block storage capacity in GB | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| ephemeralConfigured | number | Yes | Configured ephemeral storage capacity in GB | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| ephemeralIops | number | Yes | Ephemeral storage input-output operations per second | ++-----------------------+----------+-------------+--------------------------------------------------------+ +| ephemeralUsed | number | Yes | Used ephemeral storage capacity in GB | ++-----------------------+----------+-------------+--------------------------------------------------------+ + +Datatype: latencyBucketMeasure +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket: + ++--------------------------+----------+-------------+------------------------------------------------------------+ +| Field | Type | Required? | Description | ++==========================+==========+=============+============================================================+ +| countsInTheBucket | number | Yes | Number of counts falling within a defined latency bucket | ++--------------------------+----------+-------------+------------------------------------------------------------+ +| highEndOfLatencyBucket | number | No | High end of bucket range (typically in ms) | ++--------------------------+----------+-------------+------------------------------------------------------------+ +| lowEndOfLatencyBucket | number | No | Low end of bucket range (typically in ms) | ++--------------------------+----------+-------------+------------------------------------------------------------+ + +Datatype: measurementsForVfScalingFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The measurementsForVfScalingFields datatype consists of the following fields: + ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===================================+============================+=============+===========================================================================================================================================================================================================+ +| measurementsForVfScalingVersion | number | Yes | Version of the measurementsForVfScalingFields block (currently: 2.0) | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| additionalFields | field [ ] | No | Additional measurement fields if needed | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| additionalMeasurements | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays if needed | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| additionalObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information, if needed | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| codecUsageArray | codecsInUse [] | No | Array of codecs in use | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| concurrentSessions | integer | No | Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| configuredEntities | integer | No | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| cpuUsageArray | cpuUsage [] | No | Usage of an array of CPUs | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| diskUsageArray | diskUsage [] | No | Usage of an array of disks | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| featureUsageArray | featuresInUse [] | No | Array of features in use | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| filesystemUsageArray | filesystemUsage [] | No | Filesystem usage of the VM on which the VNFC reporting the event is running | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| latencyDistribution | latencyBucketMeasure [ ] | No | Array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges; where latency is the duration between a service request and its fulfillment. | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| meanRequestLatency | number | No | Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| measurementInterval | number | Yes | Interval over which measurements are being reported in seconds | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| memoryUsageArray | memoryUsage [] | No | Memory usage of an array of VMs | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numberOfMediaPortsInUse | integer | No | Number of media ports in use | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| requestRate | number | No | Peak rate of service requests per second to the VNF over the measurementInterval | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vnfcScalingMetric | integer | No | Represents busy-ness of the VNF from 0 to 100 as reported by the VNFC | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vNicPerformanceArray | vNicPerformance [ ] | No | Performance metrics of an array of virtual network interface cards | ++-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: memoryUsage +^^^^^^^^^^^^^^^^^^^^^ + +The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: + ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++====================+==========+=============+==========================================================================================================+ +| memoryBuffered | number | No | Kibibytes of temporary storage for raw disk blocks | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memoryCached | number | No | Kibibytes of memory used for cache | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memoryConfigured | number | No | Kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memoryFree | number | Yes | Kibibytes of physical RAM left unused by the system | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memorySlabRecl | number | No | The part of the slab that can be reclaimed such as caches measured in kibibytes | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memorySlabUnrecl | number | No | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| memoryUsed | number | Yes | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ +| vmIdentifier | string | Yes | Virtual Machine identifier associated with the memory metrics | ++--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ + +Datatype: vNicPerformance +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The vNicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card: + ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++==========================================+==========+=============+===============================================================================================================================================+ +| receivedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedBroadcastPacketsDelta | number | No | Count of broadcast packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedDiscardedPacketsDelta | number | No | Count of discarded packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedErrorPacketsAccumulated | number | No | Cumulative count of error packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedErrorPacketsDelta | number | No | Count of error packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedMulticastPacketsDelta | number | No | Count of multicast packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedOctetsAccumulated | number | No | Cumulative count of octets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedOctetsDelta | number | No | Count of octets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedTotalPacketsAccumulated | number | No | Cumulative count of all packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedTotalPacketsDelta | number | No | Count of all packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets received as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| receivedUnicastPacketsDelta | number | No | Count of unicast packets received within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedBroadcastPacketsDelta | number | No | Count of broadcast packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedDiscardedPacketsDelta | number | No | Count of discarded packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedErrorPacketsAccumulated | number | No | Cumulative count of error packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedErrorPacketsDelta | number | No | Count of error packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedMulticastPacketsDelta | number | No | Count of multicast packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedOctetsAccumulated | number | No | Cumulative count of octets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedOctetsDelta | number | No | Count of octets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedTotalPacketsAccumulated | number | No | Cumulative count of all packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedTotalPacketsDelta | number | No | Count of all packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets transmitted as read at the end of the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| transmittedUnicastPacketsDelta | number | No | Count of unicast packets transmitted within the measurement interval | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| valuesAreSuspect | string | Yes | Enumeration: 'true'or 'false'. If 'true'then the vNicPerformance values are likely inaccurate due to counter overflow or other condtions. | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| vNicIdentifier | string | Yes | vNic identification | ++------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +'Other'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: otherFields +^^^^^^^^^^^^^^^^^^^^^ + +The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists of the following fields: + ++-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=============================+==========================+=============+==============================================================================+ +| otherFieldsVersion | number | Yes | Version of the otherFields block (currently: 1.1) | ++-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ +| hashOfNameValuePairArrays | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays | ++-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ +| jsonObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information | ++-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ +| nameValuePairs | field [ ] | No | Array of name-value pairs | ++-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ + +'State Change'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: stateChangeFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The stateChangeFields datatype consists of the following fields: + ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++============================+=============+=============+============================================================================+ +| stateChangeFieldsVersion | number | Yes | Version of the stateChangeFields block (currently: 2.0) | ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ +| additionalFields | field [ ] | No | Additional stateChange fields if needed | ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ +| newState | string | Yes | New state of the entity: 'inService', 'maintenance', 'outOfService' | ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ +| oldState | string | Yes | Previous state of the entity: 'inService', 'maintenance', 'outOfService' | ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ +| stateInterface | string | Yes | Card or port name of the entity that changed state | ++----------------------------+-------------+-------------+----------------------------------------------------------------------------+ + +'Syslog'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: syslogFields +^^^^^^^^^^^^^^^^^^^^^^ + +The syslogFields datatype consists of the following fields: + ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=======================+===========+=============+===============================================================================================================================================+ +| syslogFieldsVersion | number | Yes | Version of the syslogFields block (currently: 3.0) | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| additionalFields | string | No | Additional syslog fields if needed, provided as name=value delimited by a pipe '\|'symbol, for example: "name1=value1\|name2=value2\|"" | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| eventSourceHost | string | No | Hostname of the device | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| eventSourceType | string | Yes | Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogFacility | integer | No | Numeric code from 0 to 23 for facility: | +| | | | | +| | | | 0 kernel messages | +| | | | | +| | | | 1 user-level messages | +| | | | | +| | | | 2 mail system | +| | | | | +| | | | 3 system daemons | +| | | | | +| | | | 4 security/authorization messages | +| | | | | +| | | | 5 messages generated internally by syslogd | +| | | | | +| | | | 6 line printer subsystem | +| | | | | +| | | | 7 network news subsystem | +| | | | | +| | | | 8 UUCP subsystem | +| | | | | +| | | | 9 clock daemon | +| | | | | +| | | | 10 security/authorization messages | +| | | | | +| | | | 11 FTP daemon | +| | | | | +| | | | 12 NTP subsystem | +| | | | | +| | | | 13 log audit | +| | | | | +| | | | 14 log alert | +| | | | | +| | | | 15 clock daemon (note 2) | +| | | | | +| | | | 16 local use 0 (local0) | +| | | | | +| | | | 17 local use 1 (local1) | +| | | | | +| | | | 18 local use 2 (local2) | +| | | | | +| | | | 19 local use 3 (local3) | +| | | | | +| | | | 20 local use 4 (local4) | +| | | | | +| | | | 21 local use 5 (local5) | +| | | | | +| | | | 22 local use 6 (local6) | +| | | | | +| | | | 23 local use 7 (local7 ) | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogMsg | string | Yes | Syslog message | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogPri | integer | No | 0-192 | +| | | | | +| | | | Combined Severity and Facility | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogProc | string | No | Identifies the application that originated the message | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogProcId | number | No | A change in the value of this field indicates a discontinuity in syslog reporting | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogSData | string | No | Syslog structured data consisting of a structured data Id followed by a set of key value pairs (see below for an example) | +| | | | | +| | | | \*\*Note: SD-ID may not be present if syslogSdId is populated | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogSdId | string | No | 0-32 char in format name@number, | +| | | | | +| | | | i.e., ourSDID@32473 | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogSev | string | No | Level-of-severity enumeration in quotes below: | +| | | | | +| | | | 'Emergency': system is unusable | +| | | | | +| | | | 'Alert': action must be taken immediately | +| | | | | +| | | | 'Critical': critical conditions | +| | | | | +| | | | 'Error': error conditions | +| | | | | +| | | | 'Warning': warning conditions | +| | | | | +| | | | 'Notice': normal but significant condition | +| | | | | +| | | | 'Info': Informational: informational messages | +| | | | | +| | | | 'Debug': debug-level messages | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogTag | string | Yes | MsgId indicating the type of message such as 'TCPOUT'or 'TCPIN'; 'NILVALUE'should be used when no other value can be provided | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| syslogVer | number | No | IANA assigned version of the syslog protocol specification (typically '1') | ++-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +Example of syslogSData: + + STRUCTURED-DATA = NILVALUE / 1\*SD-ELEMENT + + SD-ELEMENT = "[" SD-ID \*(SP SD-PARAM) "]" + + SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34 + + SD-ID = SD-NAME + + PARAM-NAME = SD-NAME + + PARAM-VALUE = UTF-8-STRING ; characters '"', '\\' and + + ; ']' MUST be escaped. + + SD-NAME = 1\*32PRINTUSASCII + + ; except '=', SP, ']', %d34 (") + +'Threshold Crossing Alert'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: counter +^^^^^^^^^^^^^^^^^ + +The counter datatype consists of the following fields: + ++---------------------+----------+-------------+-----------------------------------+ +| Field | Type | Required? | Description | ++=====================+==========+=============+===================================+ +| name | string | Yes | Name of the counter | ++---------------------+----------+-------------+-----------------------------------+ +| value | string | Yes | Current value of the counter | ++---------------------+----------+-------------+-----------------------------------+ +| threshholdCrossed | string | Yes | Last threshold that was crossed | ++---------------------+----------+-------------+-----------------------------------+ +| criticality | string | Yes | Enumeration: 'CRIT', 'MAJ' | ++---------------------+----------+-------------+-----------------------------------+ + +Datatype: thresholdCrossingAlertFields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The thresholdCrossingAlertFields datatype consists of the following +fields: + ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===================================+===============+=============+=============================================================================================================================+ +| thresholdCrossing FieldsVersion | number | Yes | Version of the thresholdCrossingAlertFields block (currently: 2.0) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| additionalFields | field [ ] | No | Additional threshold crossing alert fields if needed | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| additionalParameters | counter [ ] | Yes | Array of performance counters | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| alertAction | string | Yes | Enumeration: 'SET', 'CONT', 'CLEAR' | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| alertDescription | string | Yes | Unique short alert description (e.g., NE-CPUMEM) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| alertType | string | Yes | Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| alertValue | string | No | Calculated API value (if applicable) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| associatedAlertIdList | string [ ] | No | List of eventIds associated with the event being reported | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| collectionTimestamp | string | Yes | Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| dataCollector | string | No | Specific performance collector instance used | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| elementType | string | No | Type of network element (internal AT&T field) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| eventSeverity | string | Yes | Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| eventStartTimestamp | string | Yes | Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| interfaceName | string | No | Physical or logical port or card (if applicable) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| networkService | string | No | Network name (internal AT&T field) | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ +| possibleRootCause | string | No | Reserved for future use | ++-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ + +Technology Specific Datatypes +----------------------------- + + 'Mobile Flow' Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: gtpPerFlowMetrics +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The gtpPerFlowMetrics datatype consists of the following fields: + ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++====================================+=====================+=============+===================================================================================================================================================================================================================+ +| avgBitErrorRate | number | Yes | Average bit error rate | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| avgPacketDelayVariation | number | Yes | 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 | number | Yes | Average delivery latency | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| avgReceiveThroughput | number | Yes | Average receive throughput | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| avgTransmitThroughput | number | Yes | Average transmit throughput | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| durConnectionFailedStatus | number | No | 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 | number | No | 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 | string | No | Endpoint activating the flow | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowActivationEpoch | number | Yes | 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 | number | Yes | Integer microseconds for the start of the flow connection | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowActivationTime | string | No | 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 | string | No | Endpoint deactivating the flow | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowDeactivationEpoch | number | Yes | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowDeactivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowDeactivationTime | string | Yes | 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 | string | Yes | Connection status at reporting time as a working / inactive / failed indicator value | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| gtpConnectionStatus | string | No | Current connection state at reporting time | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| gtpTunnelStatus | string | No | Current tunnel state at reporting time | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ipTosCountList | associative array | No | 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 | string | No | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| largePacketRtt | number | No | large packet round trip time | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| largePacketThreshold | number | No | large packet threshold being applied | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| maxPacketDelayVariation | number | Yes | 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 | number | No | maximum receive bit rate" | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| maxTransmitBitRate | number | No | maximum transmit bit rate | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| mobileQciCosCountList | associative array | No | 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 | string | No | Array of unique LTE QCI or UMTS class-of-service values observed in the flow | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numActivationFailures | number | Yes | Number of failed activation requests, as observed by the reporting node | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numBitErrors | number | Yes | number of errored bits | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numBytesReceived | number | Yes | number of bytes received, including retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numBytesTransmitted | number | Yes | number of bytes transmitted, including retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numDroppedPackets | number | Yes | number of received packets dropped due to errors per virtual interface | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numGtpEchoFailures | number | No | 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 | number | No | 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 | number | No | Http error count | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, including retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numL7BytesTransmitted | number | Yes | number of tunneled layer 7 bytes transmitted, excluding retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numLostPackets | number | Yes | number of lost packets | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numOutOfOrderPackets | number | Yes | number of out-of-order packets | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numPacketErrors | number | Yes | number of errored packets | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numPacketsReceivedExclRetrans | number | Yes | number of packets received, excluding retransmission | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numPacketsReceivedInclRetrans | number | Yes | number of packets received, including retransmission | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numRetries | number | Yes | number of packet retrie | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numTimeouts | number | Yes | number of packet timeouts | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| numTunneledL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, excluding retransmissions | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| roundTripTime | number | Yes | Round Trip time | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| tcpFlagCountList | associative array | No | 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 | string | No | Array of unique TCP Flags observed in the flow | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| timeToFirstByte | number | Yes | Time in milliseconds between the connection activation and first byte received | ++------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: mobileFlowFields +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The mobileFlowFields datatype consists of the following fields: + ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===========================+======================+=============+==============================================================================================================================================================================================+ +| mobileFlowFieldsVersion | number | Yes | Version of the mobileFlowFields block (currently: 2.0) | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| additionalFields | field [ ] | No | Additional mobileFlow fields if needed | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| applicationType | string | No | Application type inferred | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| appProtocolType | string | No | Application protocol | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| appProtocolVersion | string | No | Application version | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| cid | string | No | Cell Id | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| connectionType | string | No | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ecgi | string | No | Evolved Cell Global Id | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| flowDirection | string | Yes | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| gtpPerFlowMetrics | gtpPer FlowMetrics | Yes | Mobility GTP Protocol per flow metrics | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| gtpProtocolType | string | No | GTP protocol | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| gtpVersion | string | No | GTP protocol version | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| httpHeader | string | No | HTTP request header, if the flow connects to a node referenced by HTTP | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| imei | string | No | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| imsi | string | No | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ipProtocolType | string | Yes | IP protocol type e.g., TCP, UDP, RTP... | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| lac | string | No | Location area code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| mcc | string | No | Mobile country code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| mnc | string | No | Mobile network code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| msisdn | string | No | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| otherEndpointIpAddress | string | Yes | IP address for the other endpoint, as used for the flow being reported on | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| otherEndpointPort | integer | Yes | IP Port for the reporting entity, as used for the flow being reported on | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| otherFunctionalRole | string | No | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| rac | string | No | Routing area code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| radioAccessTechnology | string | No | Radio Access Technology e.g., 2G, 3G, LTE | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| reportingEndpointIpAddr | string | Yes | IP address for the reporting entity, as used for the flow being reported on | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| reportingEndpointPort | integer | Yes | IP port for the reporting entity, as used for the flow being reported on | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| sac | string | No | Service area code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| samplingAlgorithm | integer | No | 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 | string | No | Transport area code | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| tunnelId | string | No | Tunnel identifier | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vlanId | string | No | VLAN identifier used by this flow | ++---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + 'SipSignaling'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: sipSignalingFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The sipSignalingFields datatype communicates information about sip +signaling messages, parameters and signaling state; it consists of the +following fields: + ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=============================+=======================+=============+===============================================================+ +| sipSignalingFieldsVersion | number | Yes | Version of the sipSignalingFields block (currently: 1.0) | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| additionalInformation | field [ ] | No | Additional sipSignaling fields | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| compressedSip | string | No | The full SIP request/response including headers and bodies | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| correlator | string | Yes | Constant across all events on this call | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| localIpAddress | string | Yes | Ip address on VNF | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| localPort | string | Yes | Port on VNF | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| remoteIpAddress | string | Yes | IP address of peer endpoint | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| remotePort | string | Yes | Port of peer endpoint | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| summarySip | string | No | The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc) | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ +| vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names | ++-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ + + 'Voice Quality'Domain Datatypes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Datatype: endOfCallVqmSummaries +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The endOfCallVqmSummaries datatype provides end of call voice quality +metrics; it consists of the following fields: + ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++===============================+==========+=============+==================================================================================================================================================================================================================+ +| adjacencyName | string | Yes | Adjacency name | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointDescription | string | Yes | Enumeration: 'Caller', 'Callee' | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointJitter | number | No | Endpoint jitter | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpOctetsDiscarded | number | No | Endpoint RTP octets discarded | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpOctetsReceived | number | No | Endpoint RTP octets received | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpOctetsSent | number | No | Endpoint RTP octets sent | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpPacketsDiscarded | number | No | Endpoint RTP packets discarded | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpPacketsReceived | number | No | Endpoint RTP packets received | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| endpointRtpPacketsSent | number | No | Endpoint RTP packets sent | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localJitter | number | No | Local jitter | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpOctetsDiscarded | number | No | Local RTP octets discarded | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpOctetsReceived | number | No | Local RTP octets received | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpOctetsSent | number | No | Local RTP octets sent | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpPacketsDiscarded | number | No | Local RTP packets discarded | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpPacketsReceived | number | No | Local RTP packets received | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| localRtpPacketsSent | number | No | Local RTP packets sent | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| mosCqe | number | No | Decimal range from 1 to 5 (1 decimal place) | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| packetsLost | number | No | Packets lost | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| packetLossPercent | number | No | 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 decimal places) | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| rFactor | number | No | rFactor from 0 to 100 | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| roundTripDelay | number | No | Round trip delay in milliseconds | ++-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Datatype: voiceQualityFields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The voiceQualityFields datatype provides statistics related to customer +facing voice products; consists of the following fields: + ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| Field | Type | Required? | Description | ++=============================+==========================+=============+==========================================================================+ +| voiceQualityFieldsVersion | number | Yes | Version of the voiceQualityFields block (currently: 1.0) | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| additionalInformation | field [ ] | No | Additional voice quality fields | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| calleeSideCodec | string | Yes | Callee codec for the call | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| callerSideCodec | string | Yes | Caller codec for the call | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| correlator | string | Yes | Constant across all events on this call | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| endOfCallVqmSummaries | endOfCallVqm Summaries | No | End of call voice quality metric summaries | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| phoneNumber | string | No | Phone number associated with the correlator | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| midCallRtcp | string | Yes | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ +| vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names | ++-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ + +Exceptions +========== + +RESTful Web Services Exceptions +------------------------------- + +RESTful services generate and send exceptions to clients in response to +invocation errors. Exceptions send HTTP status codes (specified later in +this document for each operation). HTTP status codes may be followed by +an optional JSON exception structure described below. Two types of +exceptions may be defined: service exceptions and policy exceptions. + ++------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Field Name** | **Data Type** | **Required?** | **Description** | ++==================+============================+=================+========================================================================================================================================================================================================================================================================+ +| messageId | xs:string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. | +| | | | | +| | | | Exception numbers may be in the range of 0001 to 9999 where : | +| | | | | +| | | | - 0001 to 2999 are defined by OMA (see OMA's `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details) | +| | | | | +| | | | - 3000-9999 are available and undefined | ++------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| text | xs:string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | ++------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| variables | xs:string [0..unbounded] | No | List of zero or more strings that represent the contents of the variables used by the message text. | ++------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| url | xs:anyUrl | No | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents). | ++------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Service Exceptions +------------------ + +When a service is not able to process a request, and retrying the +request with the same information will also result in a failure, and the +issue is not related to a service policy issue, then the service will +issue a fault using the service exception fault message. Examples of +service exceptions include invalid input, lack of availability of a +required resource or a processing error. + +A service exception uses the letters 'SVC' at the beginning of the +message identifier. 'SVC'service exceptions used by the VES Event +Listener API are defined below. + ++---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ +| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | ++===============+=======================================+===============================================================+===============================================+======================+ +| SVC0001 | General service error (see SVC2000) | <custom error message> | None | 400 | ++---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ +| SVC0002 | Bad parameter | Invalid input value for message part %1 | %1: message part | 400 | ++---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ +| SVC1000 | No server resources | No server resources available to process the request | None | 500 | ++---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ +| SVC2000 | More elaborate version of SVC0001 | The following service error occurred: %1. Error code is %2. | %1: human readable description of the error | 400 | +| | | | | | +| | | | %2: error code | | ++---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ + + Table - Service Exceptions + +Policy Exceptions +----------------- + +When a service is not able to complete because the request fails to meet +a policy criteria, then the service will issue a fault using the policy +exception fault message. To clarify how a policy exception differs from +a service exception, consider that all the input to an operation may be +valid as meeting the required input for the operation (thus no service +exception), but using that input in the execution of the service may +result in conditions that require the service not to complete. Examples +of policy exceptions include privacy violations, requests not permitted +under a governing service agreement or input content not acceptable to +the service provider. + +A Policy Exception uses the letters 'POL' at the beginning of the +message identifier. 'POL'policy exceptions used by the VES Event +Listener API are defined below. + ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ +| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | ++===============+======================================+==============================================================+===============================================+======================+ +| POL0001 | General policy error (see POL2000) | A policy error occurred. | None | 401 | ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ +| POL1009 | User not provisioned for service | User has not been provisioned for service | None | 401 | ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ +| POL1010 | User suspended from service | User has been suspended from service | None | 401 | ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ +| POL2000 | More elaborate version of POL0001 | The following policy error occurred: %1. Error code is %2. | %1: human readable description of the error | 401 | +| | | | | | +| | | | %2: error code | | ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ +| POL9003 | Message size exceeds limit | Message content size exceeds the allowable limit | None | 400 | ++---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ + + Table - Policy Exceptions + +RESTful Web Services Definition +=============================== + +REST Operation Overview +----------------------- + +REST Operation Summary +~~~~~~~~~~~~~~~~~~~~~~~ + ++--------------------------------+------------+----------------------------------------------------------------------------+ +| **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** | +| | | | +| | **Verb** | | ++--------------------------------+------------+----------------------------------------------------------------------------+ +| publishAnyEvent | POST | /eventListener/v{apiVersion} | ++--------------------------------+------------+----------------------------------------------------------------------------+ +| publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch | ++--------------------------------+------------+----------------------------------------------------------------------------+ +| provideClientThrottlingState | POST | /eventListener/v{apiVersion}/clientThrottlingState | ++--------------------------------+------------+----------------------------------------------------------------------------+ + +Table - REST Operation Summary + +Api Version +~~~~~~~~~~~ + +apiVersion is used to describe the major version number of the event +listener API (which is the same as the major version number of this +specification). When this number changes, the implication is: clients of +older versions will break in some way, if they try to use the new API +without modification (e.g., unmodified v1 clients would not be able to +use v2 without error). + +Commands Toward Event Source Clients +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Note: Vendors are not currently required to implement support for +command processing; in addition, command processing may be supported by +an App-C interface in future. + +This specification supports commands from event consumers back toward +event source clients. This enables the event consumer (e.g., AT&T event +collectors) to command event sources to change their measurement +intervals or throttle the information they are sending to the event +consumer. Note that commands are sent as part of the synchronous +response to events sent by the event source toward the event consumer. +This is done so that the event source does not need to host a service to +listen for commands from events consumers. The following commands are +currently supported: + ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Command** | **Description** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| heartbeatInterval Change | Commands the event source to change the interval (in seconds) it waits between heartbeat events sent to the VES Event Listener. If '0'is provided, the event source should return to its default heartbeatInterval. | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| measurementIntervalChange | Commands the event source to change its measurementInterval to the number provided (in seconds). If '0'is provided, the event source should return to its default measurementInterval. | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| provideThrottlingState | Commands the event source to invoke the provideThrottlingState operation on the event consumer. | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| throttlingSpecification | Commands the event source to throttle events as specified by the provided eventDomainThrottlingSpecification. This specification identifies the fields to suppress within the domain and even supports identification of subfields to suppress within objects or name-value pair structures. Note that required fields should not be suppressed and may result in errors being thrown by the event consumer back toward the event source when events without the required fields are sent to the event consumer. Other notes for event sources: | +| | | +| | - the default throttling state is \*off\* for all domains | +| | | +| | - the throttling state for a domain is altered only by receipt of an eventDomainThrottleSpecification for that domain | +| | | +| | - the presence of the optional suppressedFieldNames replaces any existing list of suppressed field names | +| | | +| | - if suppressedFieldNames is not provided, then any existing list of suppressed field names shall be discarded | +| | | +| | - the presence of the optional suppressedNvPairsList replaces the any existing list of suppressed name-value pairs | +| | | +| | - if suppressedNvPairsList is not provided, then any existing list of suppressed name-value pairs shall be discarded | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Buffering of Events +~~~~~~~~~~~~~~~~~~~~ + +{ServerRoot} is defined in section 3 of this document, which defines the +REST resource URL. One or more FQDNs may be provisioned in an event +source when it is instantiated or updated. If an event source is unable +to reach any of the provisioned FQDNs, it should buffer the event data +specified below, up to a maximum of 1 hour, until a connection can be +established and the events can be successfully delivered to the VES +Event Listener service. + +During such an outage, only the following events should be buffered: + +- Faults with eventSeverity of "MINOR", "MAJOR" or "CRITICAL" + +- Syslogs with syslogSev of 0-5 + +- All MeasurementsForVfScaling events + +VNFs acting as event sources should not send syslog events to the VES +Event Listener during debug mode (which is controlled via the Netconf +management interface), but should store syslog events locally for +access, and possible FTP transfer, via the VNF console (e.g., command +line interface). + +If the internal event source event buffer or local storage should +overflow, then the event source should send a Fault event, and should +discard events in a first-in, first-out (FIFO) manner (i.e., discard +oldest events first). + +Operation: publishAnyEvent +-------------------------- + +Functional Behavior +~~~~~~~~~~~~~~~~~~~ + +Allows authorized clients to publish any single event to the VES event +listener. + +- Supports only secure HTTPS (one way SSL) access. + +- Uses the HTTP verb POST + +- Supports JSON content types + +- Provides HTTP response codes as well as Service and Policy error + messages + +- Allows the event collector to use the HTTP response to command the + event source to throttle event messages it may send in the future. + +Call Flow +~~~~~~~~~ + +|image1| + +Figure - publishAnyEvent Call Flow + +Input Parameters +~~~~~~~~~~~~~~~~ + +Header Fields (note: all parameter names shall be treated as +case-insensitive): + ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Accept | string | No | Determines the format of the body of the response. Valid values are: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-length | integer | No | Note that content length is limited to 1Megabyte. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-type | string | Yes | Must be set to one of the following values: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Body Fields: + ++-----------------+-----------------+-----------------+-----------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+-----------------+-----------------------------------------------------------+ +| Event | event | Yes | Contains the JSON structure of the common event format. | ++-----------------+-----------------+-----------------+-----------------------------------------------------------+ + +Output Parameters +~~~~~~~~~~~~~~~~~ + +Header fields: + ++------------------+-----------------+-----------------+------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+------------------------------------+ +| Content-length | integer | No | Used only in error conditions. | ++------------------+-----------------+-----------------+------------------------------------+ +| Content-type | string | No | Used only in error conditions | ++------------------+-----------------+-----------------+------------------------------------+ +| Date | datetime | Yes | Date time of the response in GMT | ++------------------+-----------------+-----------------+------------------------------------+ + +Body Fields (for success responses without a commandList): no content is +provided and the header fields are not required. + +Body Fields (for success responses with one or more commands from the +event collector toward the event source): + ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| commandList | commandList | No | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation. | ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Body Fields (for error Responses): + ++-----------------+-----------------+--------------------+----------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+--------------------+----------------------------------+ +| requestError | requestError | Yes (for errors) | Used only in error conditions. | ++-----------------+-----------------+--------------------+----------------------------------+ + +HTTP Status Codes +~~~~~~~~~~~~~~~~~ + ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Code* | *Reason Phrase* | *Description* | ++==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ +| 202 | Accepted | The request has been accepted for processing | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Sample Request and Response +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sample Request +^^^^^^^^^^^^^^ + ++-------------------------------------------------------------------------------+ +| POST /eventListener/v5 HTTPS/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| | content-length: 12345 | +| | { | +| | +| "event": { | +| | +| "commonEventHeader": { | +| | +| "version": 3.0, | +| | +| "domain": "fault", | +| | +| "eventName": "Fault\_MobileCallRecording\_PilotNumberPoolExhaustion", | +| | +| "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015", | +| | +| "sequence": 0, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "EricssonOamVf", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000000, | +| | +| "lastEpochMicrosec": 1413378172000000 | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 2.0, | +| | +| "alarmCondition": "PilotNumberPoolExhaustion", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active", | +| | +| "alarmAdditionalInformation": [ | +| | +| { | +| | +| "name": "PilotNumberPoolSize", | +| | +| "value": "1000" | +| | +| } | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-------------------------------------------------------------------------------+ + +Sample Success Response #1 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + For success responses without a provided command list: + ++--------------------------+ +| HTTPS/1.1 202 Accepted | ++--------------------------+ + +Sample Success Response #2 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + For success responses with a provided command list: + ++-----------------------------------------------------------------+ +| HTTPS/1.1 202 Accepted | +| | +| content-type: application/json | +| | +| content-length: nnn | +| | +| date: Sat, 04 Jul 2015 02:03:15 GMT | +| | +| { | +| | +| "commandList": [ | +| | +| { | +| | +| "commandType": "throttlingSpecification", | +| | +| "eventDomainThrottleSpecification": { | +| | +| "eventDomain": "fault", | +| | +| "suppressedFieldNames": [ | +| | +| "alarmInterfaceA", | +| | +| "alarmAdditionalInformation" | +| | +| ] | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commandType": "throttlingSpecification", | +| | +| "eventDomainThrottleSpecification": { | +| | +| "eventDomain": "thresholdCrossingAlert", | +| | +| "suppressedFieldNames": [ | +| | +| "associatedAlertIdList", | +| | +| "possibleRootCause" | +| | +| ], | +| | +| "suppressedNvPairs" { | +| | +| "nvPairFieldName": additionalParameters", | +| | +| "suppressedNvPairNames": [ | +| | +| "someCounterName", | +| | +| "someOtherCounterName" | +| | +| ] | +| | +| } | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commandType": "measurementIntervalChange", | +| | +| "measurementInterval": 600 | +| | +| }, | +| | +| { | +| | +| "commandType": "heartbeatIntervalChange", | +| | +| "heartbeatInterval": 90 | +| | +| }, | +| | +| { | +| | +| "commandType": "provideThrottlingState" | +| | +| } | +| | +| ] | +| | +| } | ++-----------------------------------------------------------------+ + +1. .. rubric:: Sample Error Responses + :name: sample-error-responses + + 1. .. rubric:: Sample Policy Exception + :name: sample-policy-exception + ++---------------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "policyException": { | +| | +| "messageId": "POL9003", | +| | +| "text": "Message content size exceeds the allowable limit", | +| | +| } | +| | +| } | +| | +| } | ++---------------------------------------------------------------+ + +Sample Service Exception +'''''''''''''''''''''''' + ++-----------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "serviceException": { | +| | +| "messageId": "SVC2000", | +| | +| "text": "Missing Parameter: %1. Error code is %2" | +| | +| "variables": [ | +| | +| "severity", | +| | +| "400" | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------+ + +Operation: publishEventBatch +---------------------------- + +Functional Behavior +~~~~~~~~~~~~~~~~~~~ + +Allows authorized clients to publish any single event to the VES event +listener. + +- Supports only secure HTTPS (one way SSL) access. + +- Uses the HTTP verb POST + +- Supports JSON content types + +- Provides HTTP response codes as well as Service and Policy error + messages + +- Allows the event collector to use the HTTP response to command the + event source to throttle event messages it may send in the future. + +Call Flow +~~~~~~~~~ + +|image2| + +Figure " publishEventBatch Call Flow + +Input Parameters +~~~~~~~~~~~~~~~~ + +Header Fields (note: all parameter names shall be treated as +case-insensitive): + ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Accept | string | No | Determines the format of the body of the response. Valid values are: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-length | integer | No | Note that content length is limited to 1Megabyte. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-type | string | Yes | Must be set to one of the following values: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Body Fields: + ++-----------------+-----------------+-----------------+----------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+-----------------+----------------------------------------------------------+ +| eventList | eventList | Yes | Array of events conforming to the common event format. | ++-----------------+-----------------+-----------------+----------------------------------------------------------+ + +Output Parameters +~~~~~~~~~~~~~~~~~ + +Header fields: + ++------------------+-----------------+-----------------+------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+------------------------------------+ +| Content-length | integer | No | Used only in error conditions. | ++------------------+-----------------+-----------------+------------------------------------+ +| Content-type | string | No | Used only in error conditions | ++------------------+-----------------+-----------------+------------------------------------+ +| Date | datetime | Yes | Date time of the response in GMT | ++------------------+-----------------+-----------------+------------------------------------+ + +Body Fields (for success responses without a commandList): no content is +provided and the header fields are not required. + +Body Fields (for success responses with one or more commands from the +event collector toward the event source): + ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| commandList | commandList | No | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation. | ++-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Body Fields (for error Responses): + ++-----------------+-----------------+--------------------+----------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+--------------------+----------------------------------+ +| requestError | requestError | Yes (for errors) | Used only in error conditions. | ++-----------------+-----------------+--------------------+----------------------------------+ + +HTTP Status Codes +~~~~~~~~~~~~~~~~~ + ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Code* | *Reason Phrase* | *Description* | ++==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ +| 202 | Accepted | The request has been accepted for processing | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Sample Request and Response +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sample Request +^^^^^^^^^^^^^^ + ++-------------------------------------------------------------------------------+ +| POST /eventListener/v5/eventBatch HTTPS/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| | content-length: 12345 | +| | { | +| | +| "eventList": [ | +| | +| { | +| | +| "commonEventHeader": { | +| | +| "version": 3.0, | +| | +| "domain": "fault", | +| | +| "eventName": "Fault\_MobileCallRecording\_PilotNumberPoolExhaustion", | +| | +| "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015", | +| | +| "sequence": 0, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "EricssonOamVf", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000000, | +| | +| "lastEpochMicrosec": 1413378172000000 | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 2.0, | +| | +| "alarmCondition": "PilotNumberPoolExhaustion", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active", | +| | +| "alarmAdditionalInformation": [ | +| | +| { | +| | +| "name": "PilotNumberPoolSize", | +| | +| "value": "1000" | +| | +| } | +| | +| ] | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commonEventHeader": { | +| | +| "version": 3.0, | +| | +| "domain": "fault", | +| | +| "eventName": "Fault\_MobileCallRecording\_RecordingServerUnreachable", | +| | +| "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546025", | +| | +| "sequence": 0, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "EricssonOamVf", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000010, | +| | +| "lastEpochMicrosec": 1413378172000010 | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 2.0, | +| | +| "alarmCondition": "RecordingServerUnreachable", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Recording server unreachable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active" | +| | +| } | +| | +| } | +| | +| ] | +| | +| } | ++-------------------------------------------------------------------------------+ + +Sample Success Response #1 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + For success responses without a provided commandList: + ++--------------------------+ +| HTTPS/1.1 202 Accepted | ++--------------------------+ + +Sample Success Response #2 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + For success responses with a provided commandList: + ++-----------------------------------------------------------------+ +| HTTPS/1.1 202 Accepted | +| | +| content-type: application/json | +| | +| content-length: nnn | +| | +| date: Sat, 04 Jul 2015 02:03:15 GMT | +| | +| { | +| | +| "commandList": [ | +| | +| { | +| | +| "commandType": "throttlingSpecification", | +| | +| "eventDomainThrottleSpecification": { | +| | +| "eventDomain": "fault", | +| | +| "suppressedFieldNames": [ | +| | +| "alarmInterfaceA", | +| | +| "alarmAdditionalInformation" | +| | +| ] | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commandType": "throttlingSpecification", | +| | +| "eventDomainThrottleSpecification": { | +| | +| "eventDomain": "thresholdCrossingAlert", | +| | +| "suppressedFieldNames": [ | +| | +| "associatedAlertIdList", | +| | +| "possibleRootCause" | +| | +| ], | +| | +| "suppressedNvPairs" { | +| | +| "nvPairFieldName": additionalParameters", | +| | +| "suppressedNvPairNames": [ | +| | +| "someCounterName", | +| | +| "someOtherCounterName" | +| | +| ] | +| | +| } | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commandType": "measurementIntervalChange", | +| | +| "measurementInterval": 600 | +| | +| }, | +| | +| { | +| | +| "commandType": "heartbeatIntervalChange", | +| | +| "heartbeatInterval": 90 | +| | +| }, | +| | +| { | +| | +| "commandType": "provideThrottlingState" | +| | +| } | +| | +| ] | +| | +| } | ++-----------------------------------------------------------------+ + +1. .. rubric:: Sample Error Responses + :name: sample-error-responses-1 + + 1. .. rubric:: Sample Policy Exception + :name: sample-policy-exception-1 + ++---------------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "policyException": { | +| | +| "messageId": "POL9003", | +| | +| "text": "Message content size exceeds the allowable limit", | +| | +| } | +| | +| } | +| | +| } | ++---------------------------------------------------------------+ + +Sample Service Exception +'''''''''''''''''''''''' + ++-----------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "serviceException": { | +| | +| "messageId": "SVC2000", | +| | +| "text": "Missing Parameter: %1. Error code is %2" | +| | +| "variables": [ | +| | +| "severity", | +| | +| "400" | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------+ + +Operation: provideThrottlingState +--------------------------------- + +Functional Behavior +~~~~~~~~~~~~~~~~~~~ + +Allows authorized event source clients to report the state of event +throttling by event domain that is currently in force in the event +source. + +- Supports only secure HTTPS (one way SSL) access. + +- Uses the HTTP verb POST + +- Supports application/json content types + +- Provides HTTP response codes as well as Service and Policy error + messages + +Call Flow +~~~~~~~~~ + +|image3| + +Figure - provideClientThrottlingState Call Flow + +Input Parameters +~~~~~~~~~~~~~~~~ + +Header Fields (note: all parameter names shall be treated as +case-insensitive): + ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Accept | string | No | Determines the format of the body of the response. Valid values are: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-length | integer | No | Note that content length is limited to 1Megabyte. | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content-type | string | Yes | Must be set to one of the following values: | +| | | | | +| | | | - application/json | ++------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Body Fields: + ++------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| eventThrottlingState | eventThrottlingState | Yes | Consists of an eventThrottlingMode enumeration which can be 'normal'or 'throttled'followed by an optional array of eventDomainThrottleSpecification structures | ++------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Output Parameters +~~~~~~~~~~~~~~~~~ + +The only output parameters are an HTTP response code and message. + ++------------------+-----------------+-----------------+----------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++------------------+-----------------+-----------------+----------------------------------+ +| Content-length | integer | No | Used only in error conditions. | ++------------------+-----------------+-----------------+----------------------------------+ +| Content-type | string | No | Used only in error conditions. | ++------------------+-----------------+-----------------+----------------------------------+ + +Body Fields: + ++-----------------+-----------------+-----------------+----------------------------------+ +| **Parameter** | **Data Type** | **Required?** | **Brief description** | ++-----------------+-----------------+-----------------+----------------------------------+ +| requestError | requestError | No | Used only in error conditions. | ++-----------------+-----------------+-----------------+----------------------------------+ + +HTTP Status Codes +~~~~~~~~~~~~~~~~~ + ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Code* | *Reason Phrase* | *Description* | ++==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ +| 204 | No Content | The throttling state update message has been accepted. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 409 | Locked | The request could not be completed due to a conflict with the current state of the resource. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 503 | Service Unavailable | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 504 | Gateway Timeout | The server, while acting as a gateway or proxy, did not receive a timely response from the upstream process. | ++----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Sample Request and Response +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sample Request +^^^^^^^^^^^^^^ + ++----------------------------------------------------------+ +| POST /eventListener/v5/clientThrottlingState HTTPS/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| content-length: nnn | +| | +| accept: application/json | +| | +| { | +| | +| "eventThrottlingState": { | +| | +| "eventThrottlingMode": "throttled", | +| | +| "eventDomainThrottleSpecificationList": [ | +| | +| { | +| | +| "eventDomain": "fault", | +| | +| "suppressedFieldNames": [ | +| | +| "alarmInterfaceA", | +| | +| "alarmAdditionalInformation" | +| | +| ] | +| | +| }, | +| | +| { | +| | +| "eventDomain": "thresholdCrossingAlert", | +| | +| "suppressedFieldNames": [ | +| | +| "associatedAlertIdList", | +| | +| "possibleRootCause" | +| | +| ], | +| | +| "suppressedNvPairsList": [ | +| | +| { | +| | +| "nvPairFieldName": "additionalParameters", | +| | +| "suppressedNvPairNames": [ | +| | +| "someCounterName", | +| | +| "someOtherCounterName" | +| | +| ] | +| | +| } | +| | +| ] | +| | +| } | +| | +| ] | +| | +| } | +| | +| } | ++----------------------------------------------------------+ + +Sample Success Response +^^^^^^^^^^^^^^^^^^^^^^^ + ++----------------------------+ +| HTTPS/1.1 204 No Content | ++----------------------------+ + +1. .. rubric:: Sample Error Responses + :name: sample-error-responses-2 + + 1. .. rubric:: Sample Policy Exception + :name: sample-policy-exception-2 + ++---------------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "policyException": { | +| | +| "messageId": "POL9003", | +| | +| "text": "Message content size exceeds the allowable limit", | +| | +| } | +| | +| } | +| | +| } | ++---------------------------------------------------------------+ + +Sample Service Exception +'''''''''''''''''''''''' + ++-----------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| { | +| | +| "requestError": { | +| | +| "serviceException": { | +| | +| "messageId": "SVC2000", | +| | +| "text": "Missing Parameter: %1. Error code is %2" | +| | +| "variables": [ | +| | +| "severity", | +| | +| "400" | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + |