diff options
Diffstat (limited to 'docs/sections/apis/ves.rst')
| -rw-r--r-- | docs/sections/apis/ves.rst | 161 |
1 files changed, 81 insertions, 80 deletions
diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst index 4fb338f8..d03cd513 100644 --- a/docs/sections/apis/ves.rst +++ b/docs/sections/apis/ves.rst @@ -99,7 +99,7 @@ Body :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. code-block:: javascript @@ -1063,7 +1063,7 @@ Body :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. code-block:: javascript @@ -1997,7 +1997,7 @@ Security :widths: 15, 45 :ref:`basicAuth <securities_basicAuth>`, "" - + Data Structures ~~~~~~~~~~~~~~~ @@ -2011,9 +2011,9 @@ ApiResponseMessage Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - code | No | integer | int32 | | - message | No | string | | | - type | No | string | | | + code | No | integer | int32 | | + message | No | string | | | + type | No | string | | | .. _d_f598222d7a83ca9c3538556b263682d1: @@ -2025,7 +2025,7 @@ VES5Request Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. _d_df249c51a416f54e5609f2ffffe059c0: @@ -2039,8 +2039,8 @@ number of times an identified codec was used over the measurementInterval :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - codecIdentifier | Yes | string | | | - numberInUse | Yes | integer | | | + codecIdentifier | Yes | string | | | + numberInUse | Yes | integer | | | .. _d_a68e1b21fdcef792db73f711201c56ad: @@ -2054,10 +2054,10 @@ command from an event collector toward an event source :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} | - eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | | - heartbeatInterval | No | integer | | | - measurementInterval | No | integer | | | + commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} | + eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | | + heartbeatInterval | No | integer | | | + measurementInterval | No | integer | | | .. _d_2dc9a27be1410f60241c5f63c636bb7e: @@ -2075,7 +2075,7 @@ fields common to all events eventId | Yes | string | | | event key that is unique to the event source eventName | Yes | string | | | unique event name eventType | No | string | | | for example - applicationVnf, guestOS, hostOS, platform - internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | | + internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | | lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds nfNamingCode | No | string | | | 4 character network function type, aligned with vnf naming standards nfcNamingCode | No | string | | | 3 character network function component type, aligned with vfc naming standards @@ -2100,10 +2100,10 @@ performance counter :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} | - name | Yes | string | | | - thresholdCrossed | Yes | string | | | - value | Yes | string | | | + criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} | + name | Yes | string | | | + thresholdCrossed | Yes | string | | | + value | Yes | string | | | .. _d_6f081937f31c09078c8acf9212d6c449: @@ -2196,23 +2196,23 @@ provides end of call voice quality metrics adjacencyName | Yes | string | | | adjacency name endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee - endpointJitter | No | number | | | - endpointRtpOctetsDiscarded | No | number | | | - endpointRtpOctetsReceived | No | number | | | - endpointRtpOctetsSent | No | number | | | - endpointRtpPacketsDiscarded | No | number | | | - endpointRtpPacketsReceived | No | number | | | - endpointRtpPacketsSent | No | number | | | - localJitter | No | number | | | - localRtpOctetsDiscarded | No | number | | | - localRtpOctetsReceived | No | number | | | - localRtpOctetsSent | No | number | | | - localRtpPacketsDiscarded | No | number | | | - localRtpPacketsReceived | No | number | | | - localRtpPacketsSent | No | number | | | + endpointJitter | No | number | | | + endpointRtpOctetsDiscarded | No | number | | | + endpointRtpOctetsReceived | No | number | | | + endpointRtpOctetsSent | No | number | | | + endpointRtpPacketsDiscarded | No | number | | | + endpointRtpPacketsReceived | No | number | | | + endpointRtpPacketsSent | No | number | | | + localJitter | No | number | | | + localRtpOctetsDiscarded | No | number | | | + localRtpOctetsReceived | No | number | | | + localRtpOctetsSent | No | number | | | + localRtpPacketsDiscarded | No | number | | | + localRtpPacketsReceived | No | number | | | + localRtpPacketsSent | No | number | | | mosCqe | No | number | | | 1-5 1dp packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp) - packetsLost | No | number | | | + packetsLost | No | number | | | rFactor | No | number | | | 0-100 roundTripDelay | No | number | | | millisecs @@ -2228,17 +2228,17 @@ the root level of the common event format :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | | - faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | | - heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | | - measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | | - mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | | - otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | | - sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | | - stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | | - syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | | - thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | | - voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | | + commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | | + faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | | + heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | | + measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | | + mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | | + otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | | + sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | | + stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | | + syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | | + thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | | + voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | | .. _d_4089a4a9ee684770c6f37a588a577589: @@ -2290,8 +2290,8 @@ number of times an identified feature was used over the measurementInterval :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - featureIdentifier | Yes | string | | | - featureUtilization | Yes | integer | | | + featureIdentifier | Yes | string | | | + featureUtilization | Yes | integer | | | .. _d_a9799335edbbc52c7f0c5191f7bd09ee: @@ -2305,8 +2305,8 @@ name value pair :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - name | Yes | string | | | - value | Yes | string | | | + name | Yes | string | | | + value | Yes | string | | | .. _d_18e1fa5fd6774deefce826b075f8b6e7: @@ -2320,13 +2320,13 @@ disk usage of an identified virtual machine in gigabytes and/or gigabytes per se :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - blockConfigured | Yes | number | | | - blockIops | Yes | number | | | - blockUsed | Yes | number | | | - ephemeralConfigured | Yes | number | | | - ephemeralIops | Yes | number | | | - ephemeralUsed | Yes | number | | | - filesystemName | Yes | string | | | + blockConfigured | Yes | number | | | + blockIops | Yes | number | | | + blockUsed | Yes | number | | | + ephemeralConfigured | Yes | number | | | + ephemeralIops | Yes | number | | | + ephemeralUsed | Yes | number | | | + filesystemName | Yes | string | | | .. _d_bb1527d221e848e0896c78552979238b: @@ -2447,11 +2447,11 @@ meta-information about an instance of a jsonObject along with the actual object :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - objectInstance | Yes | :ref:`objectInstance <i_c0493c6178d712e91e73c63587e27067>` | | | an instance conforming to the jsonObject schema + objectInstance | Yes | :ref:`objectInstance <i_4cf8290bf745cd386f0a55ec865aafd5>` | | | an instance conforming to the jsonObject schema objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` | | | an ordered set of keys that identifies this particular instance of jsonObject -.. _i_c0493c6178d712e91e73c63587e27067: +.. _i_4cf8290bf745cd386f0a55ec865aafd5: **Objectinstance schema:** @@ -2488,9 +2488,9 @@ number of counts falling within a defined latency bucket :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - countsInTheBucket | Yes | number | | | - highEndOfLatencyBucket | No | number | | | - lowEndOfLatencyBucket | No | number | | | + countsInTheBucket | Yes | number | | | + highEndOfLatencyBucket | No | number | | | + lowEndOfLatencyBucket | No | number | | | .. _d_669cf98e276c9992abd27056c432bbb2: @@ -2565,7 +2565,7 @@ mobileFlow fields connectionType | No | string | | | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc ecgi | No | string | | | Evolved Cell Global Id flowDirection | Yes | string | | | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow - gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | | + gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | | gtpProtocolType | No | string | | | GTP protocol gtpVersion | No | string | | | GTP protocol version httpHeader | No | string | | | HTTP request header, if the flow connects to a node referenced by HTTP @@ -2604,7 +2604,7 @@ an array of name value pairs along with a name for the array :widths: 20, 10, 15, 15, 30, 25 arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs - name | Yes | string | | | + name | Yes | string | | | .. _d_5a79cd7ce784d60fd832d9c7c0a24322: @@ -2661,7 +2661,7 @@ sip signaling fields remotePort | Yes | string | | | port of peer endpoint sipSignalingFieldsVersion | Yes | number | | | version of the sipSignalingFields block summarySip | No | string | | | the SIP Method or Response (INVITE, 200 OK, BYE, etc) - vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | .. _d_c5450f1a263d0a2b0c64c96119f7d759: @@ -2704,24 +2704,24 @@ syslogFields Model Structure sysLog fields .. csv-table:: - :delim: ; + :delim: | :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - additionalFields ; No ; string ; ; ; additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|' - eventSourceHost ; No ; string ; ; ; hostname of the device - eventSourceType ; Yes ; string ; ; ; type of event source, examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction - syslogFacility ; No ; integer ; ; ; numeric code from 0 to 23 for facility--see table in documentation - syslogFieldsVersion ; Yes ; number ; ; ; version of the syslogFields block - syslogMsg ; Yes ; string ; ; ; syslog message - syslogPri ; No ; integer ; ; ; 0-192 combined severity and facility - syslogProc ; No ; string ; ; ; identifies the application that originated the message - syslogProcId ; No ; number ; ; ; a change in the value of this field indicates a discontinuity in syslog reporting - syslogSData ; No ; string ; ; ; syslog structured data consisting of a structured data Id followed by a set of key value pairs - syslogSdId ; No ; string ; ; ; 0-32 char in format name@number for example ourSDID@32473 - syslogSev ; No ; string ; ; {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} , numerical Code for severity derived from syslogPri as remaider of syslogPri / 8 - syslogTag ; Yes ; string ; ; ; msgId indicating the type of message such as TCPOUT or TCPIN, NILVALUE should be used when no other value can be provided - syslogVer ; No ; number ; ; ; IANA assigned version of the syslog protocol specification - typically 1 + additionalFields | No | string | | | additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|' + eventSourceHost | No | string | | | hostname of the device + eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction + syslogFacility | No | integer | | | numeric code from 0 to 23 for facility--see table in documentation + syslogFieldsVersion | Yes | number | | | version of the syslogFields block + syslogMsg | Yes | string | | | syslog message + syslogPri | No | integer | | | 0-192 combined severity and facility + syslogProc | No | string | | | identifies the application that originated the message + syslogProcId | No | number | | | a change in the value of this field indicates a discontinuity in syslog reporting + syslogSData | No | string | | | syslog structured data consisting of a structured data Id followed by a set of key value pairs + syslogSdId | No | string | | | 0-32 char in format name@number for example ourSDID@32473 + syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8 + syslogTag | Yes | string | | | msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided + syslogVer | No | number | | | IANA assigned version of the syslog protocol specification - typically 1 .. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20: @@ -2827,8 +2827,9 @@ provides statistics related to customer facing voice products calleeSideCodec | Yes | string | | | callee codec for the call callerSideCodec | Yes | string | | | caller codec for the call correlator | Yes | string | | | this is the same for all events on this call - endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | | + endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | | midCallRtcp | Yes | string | | | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers phoneNumber | No | string | | | phone number associated with the correlator - vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block + |