swagger_vescollector.yaml

   1 swagger: '2.0'
   2 info:
   3   version: 1.1.0
   4   title: VES Collector
   5   description: >
   6     Virtual Event Streaming (VES) Collector is RESTful collector for processing
   7     JSON messages. The collector verifies the source and validates the events
   8     against VES schema before distributing to DMAAP MR topics
   9   contact:
  10     email: dcae@lists.openecomp.org
  11 externalDocs:
  12   description: VESCollector
  13   url: 'https://gerrit.onap.org/r/#/admin/projects/dcaegen2/collectors/ves'
  14 schemes:
  15   - http
  16   - https
  17 securityDefinitions:
  18   basicAuth:
  19     type: basic
  20     description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
  21 paths:
  22   /eventListener/v5:
  23     post:
  24       security:
  25         - basicAuth: []
  26       summary: ''
  27       description: uri for posting VES event objects
  28       operationId: veseventPut
  29       consumes:
  30         - application/json
  31       produces:
  32         - application/json
  33       parameters:
  34         - in: body
  35           name: body
  36           required: true
  37           schema:
  38             $ref: '#/definitions/VES5Request'
  39       responses:
  40         '200':
  41           description: VES Event Accepted.
  42           schema:
  43             $ref: '#/definitions/ApiResponseMessage'
  44         '400':
  45           description: Bad request provided
  46           schema:
  47             $ref: '#/definitions/ApiResponseMessage'
  48         '401':
  49           description: Unauthorized request
  50           schema:
  51             $ref: '#/definitions/ApiResponseMessage'
  52         '503':
  53           description: Service Unavailable
  54           schema:
  55             $ref: '#/definitions/ApiResponseMessage'
  56   /eventListener/v5/eventBatch:
  57     post:
  58       security:
  59         - basicAuth: []
  60       summary: ''
  61       description: uri for posting VES batch event objects
  62       operationId: veseventbatchPut
  63       consumes:
  64         - application/json
  65       produces:
  66         - application/json
  67       parameters:
  68         - in: body
  69           name: body
  70           required: true
  71           schema:
  72             $ref: '#/definitions/VES5Request'
  73       responses:
  74         '200':
  75           description: VES Event Accepted.
  76           schema:
  77             $ref: '#/definitions/ApiResponseMessage'
  78         '400':
  79           description: Bad request provided
  80           schema:
  81             $ref: '#/definitions/ApiResponseMessage'
  82         '401':
  83           description: Unauthorized request
  84           schema:
  85             $ref: '#/definitions/ApiResponseMessage'
  86         '503':
  87           description: Service Unavailable
  88           schema:
  89             $ref: '#/definitions/ApiResponseMessage'
  90   /healthcheck:
  91     get:
  92       responses:
  93         '200':
  94           description: healthcheck successful
  95 definitions:
  96   ApiResponseMessage:
  97     type: object
  98     properties:
  99       code:
 100         type: integer
 101         format: int32
 102       type:
 103         type: string
 104       message:
 105         type: string
 106   VES5Request:
 107     type: object
 108     properties:
 109       event:
 110         $ref: '#/definitions/event'
 111   codecsInUse:
 112     description: number of times an identified codec was used over the measurementInterval
 113     type: object
 114     properties:
 115       codecIdentifier:
 116         type: string
 117       numberInUse:
 118         type: integer
 119     required:
 120       - codecIdentifier
 121       - numberInUse
 122   command:
 123     description: command from an event collector toward an event source
 124     type: object
 125     properties:
 126       commandType:
 127         type: string
 128         enum:
 129           - heartbeatIntervalChange
 130           - measurementIntervalChange
 131           - provideThrottlingState
 132           - throttlingSpecification
 133       eventDomainThrottleSpecification:
 134         $ref: '#/definitions/eventDomainThrottleSpecification'
 135       heartbeatInterval:
 136         type: integer
 137       measurementInterval:
 138         type: integer
 139     required:
 140       - commandType
 141   commonEventHeader:
 142     description: fields common to all events
 143     type: object
 144     properties:
 145       domain:
 146         description: the eventing domain associated with the event
 147         type: string
 148         enum:
 149           - fault
 150           - heartbeat
 151           - measurementsForVfScaling
 152           - mobileFlow
 153           - other
 154           - sipSignaling
 155           - stateChange
 156           - syslog
 157           - thresholdCrossingAlert
 158           - voiceQuality
 159       eventId:
 160         description: event key that is unique to the event source
 161         type: string
 162       eventName:
 163         description: unique event name
 164         type: string
 165       eventType:
 166         description: 'for example - applicationVnf, guestOS, hostOS, platform'
 167         type: string
 168       internalHeaderFields:
 169         $ref: '#/definitions/internalHeaderFields'
 170       lastEpochMicrosec:
 171         description: >-
 172           the latest unix time aka epoch time associated with the event from any
 173           component--as microseconds elapsed since 1 Jan 1970 not including leap
 174           seconds
 175         type: number
 176       nfcNamingCode:
 177         description: >-
 178           3 character network function component type, aligned with vfc naming
 179           standards
 180         type: string
 181       nfNamingCode:
 182         description: '4 character network function type, aligned with vnf naming standards'
 183         type: string
 184       priority:
 185         description: processing priority
 186         type: string
 187         enum:
 188           - High
 189           - Medium
 190           - Normal
 191           - Low
 192       reportingEntityId:
 193         description: >-
 194           UUID identifying the entity reporting the event, for example an OAM
 195           VM; must be populated by the ATT enrichment process
 196         type: string
 197       reportingEntityName:
 198         description: >-
 199           name of the entity reporting the event, for example, an EMS name; may
 200           be the same as sourceName
 201         type: string
 202       sequence:
 203         description: >-
 204           ordering of events communicated by an event source instance or 0 if
 205           not needed
 206         type: integer
 207       sourceId:
 208         description: >-
 209           UUID identifying the entity experiencing the event issue; must be
 210           populated by the ATT enrichment process
 211         type: string
 212       sourceName:
 213         description: name of the entity experiencing the event issue
 214         type: string
 215       startEpochMicrosec:
 216         description: >-
 217           the earliest unix time aka epoch time associated with the event from
 218           any component--as microseconds elapsed since 1 Jan 1970 not including
 219           leap seconds
 220         type: number
 221       version:
 222         description: version of the event header
 223         type: number
 224     required:
 225       - domain
 226       - eventId
 227       - eventName
 228       - lastEpochMicrosec
 229       - priority
 230       - reportingEntityName
 231       - sequence
 232       - sourceName
 233       - startEpochMicrosec
 234       - version
 235   counter:
 236     description: performance counter
 237     type: object
 238     properties:
 239       criticality:
 240         type: string
 241         enum:
 242           - CRIT
 243           - MAJ
 244       name:
 245         type: string
 246       thresholdCrossed:
 247         type: string
 248       value:
 249         type: string
 250     required:
 251       - criticality
 252       - name
 253       - thresholdCrossed
 254       - value
 255   cpuUsage:
 256     description: usage of an identified CPU
 257     type: object
 258     properties:
 259       cpuIdentifier:
 260         description: cpu identifer
 261         type: string
 262       cpuIdle:
 263         description: percentage of CPU time spent in the idle task
 264         type: number
 265       cpuUsageInterrupt:
 266         description: percentage of time spent servicing interrupts
 267         type: number
 268       cpuUsageNice:
 269         description: >-
 270           percentage of time spent running user space processes that have been
 271           niced
 272         type: number
 273       cpuUsageSoftIrq:
 274         description: percentage of time spent handling soft irq interrupts
 275         type: number
 276       cpuUsageSteal:
 277         description: >-
 278           percentage of time spent in involuntary wait which is neither user,
 279           system or idle time and is effectively time that went missing
 280         type: number
 281       cpuUsageSystem:
 282         description: percentage of time spent on system tasks running the kernel
 283         type: number
 284       cpuUsageUser:
 285         description: percentage of time spent running un-niced user space processes
 286         type: number
 287       cpuWait:
 288         description: percentage of CPU time spent waiting for I/O operations to complete
 289         type: number
 290       percentUsage:
 291         description: >-
 292           aggregate cpu usage of the virtual machine on which the VNFC reporting
 293           the event is running
 294         type: number
 295     required:
 296       - cpuIdentifier
 297       - percentUsage
 298   diskUsage:
 299     description: usage of an identified disk
 300     type: object
 301     properties:
 302       diskIdentifier:
 303         description: disk identifier
 304         type: string
 305       diskIoTimeAvg:
 306         description: >-
 307           milliseconds spent doing input/output operations over 1 sec; treat
 308           this metric as a device load percentage where 1000ms  matches 100%
 309           load; provide the average over the measurement interval
 310         type: number
 311       diskIoTimeLast:
 312         description: >-
 313           milliseconds spent doing input/output operations over 1 sec; treat
 314           this metric as a device load percentage where 1000ms  matches 100%
 315           load; provide the last value measurement within the measurement
 316           interval
 317         type: number
 318       diskIoTimeMax:
 319         description: >-
 320           milliseconds spent doing input/output operations over 1 sec; treat
 321           this metric as a device load percentage where 1000ms  matches 100%
 322           load; provide the maximum value measurement within the measurement
 323           interval
 324         type: number
 325       diskIoTimeMin:
 326         description: >-
 327           milliseconds spent doing input/output operations over 1 sec; treat
 328           this metric as a device load percentage where 1000ms  matches 100%
 329           load; provide the minimum value measurement within the measurement
 330           interval
 331         type: number
 332       diskMergedReadAvg:
 333         description: >-
 334           number of logical read operations that were merged into physical read
 335           operations, e.g., two logical reads were served by one physical disk
 336           access; provide the average measurement within the measurement
 337           interval
 338         type: number
 339       diskMergedReadLast:
 340         description: >-
 341           number of logical read operations that were merged into physical read
 342           operations, e.g., two logical reads were served by one physical disk
 343           access; provide the last value measurement within the measurement
 344           interval
 345         type: number
 346       diskMergedReadMax:
 347         description: >-
 348           number of logical read operations that were merged into physical read
 349           operations, e.g., two logical reads were served by one physical disk
 350           access; provide the maximum value measurement within the measurement
 351           interval
 352         type: number
 353       diskMergedReadMin:
 354         description: >-
 355           number of logical read operations that were merged into physical read
 356           operations, e.g., two logical reads were served by one physical disk
 357           access; provide the minimum value measurement within the measurement
 358           interval
 359         type: number
 360       diskMergedWriteAvg:
 361         description: >-
 362           number of logical write operations that were merged into physical
 363           write operations, e.g., two logical writes were served by one physical
 364           disk access; provide the average measurement within the measurement
 365           interval
 366         type: number
 367       diskMergedWriteLast:
 368         description: >-
 369           number of logical write operations that were merged into physical
 370           write operations, e.g., two logical writes were served by one physical
 371           disk access; provide the last value measurement within the measurement
 372           interval
 373         type: number
 374       diskMergedWriteMax:
 375         description: >-
 376           number of logical write operations that were merged into physical
 377           write operations, e.g., two logical writes were served by one physical
 378           disk access; provide the maximum value measurement within the
 379           measurement interval
 380         type: number
 381       diskMergedWriteMin:
 382         description: >-
 383           number of logical write operations that were merged into physical
 384           write operations, e.g., two logical writes were served by one physical
 385           disk access; provide the minimum value measurement within the
 386           measurement interval
 387         type: number
 388       diskOctetsReadAvg:
 389         description: >-
 390           number of octets per second read from a disk or partition; provide the
 391           average measurement within the measurement interval
 392         type: number
 393       diskOctetsReadLast:
 394         description: >-
 395           number of octets per second read from a disk or partition; provide the
 396           last measurement within the measurement interval
 397         type: number
 398       diskOctetsReadMax:
 399         description: >-
 400           number of octets per second read from a disk or partition; provide the
 401           maximum measurement within the measurement interval
 402         type: number
 403       diskOctetsReadMin:
 404         description: >-
 405           number of octets per second read from a disk or partition; provide the
 406           minimum measurement within the measurement interval
 407         type: number
 408       diskOctetsWriteAvg:
 409         description: >-
 410           number of octets per second written to a disk or partition; provide
 411           the average measurement within the measurement interval
 412         type: number
 413       diskOctetsWriteLast:
 414         description: >-
 415           number of octets per second written to a disk or partition; provide
 416           the last measurement within the measurement interval
 417         type: number
 418       diskOctetsWriteMax:
 419         description: >-
 420           number of octets per second written to a disk or partition; provide
 421           the maximum measurement within the measurement interval
 422         type: number
 423       diskOctetsWriteMin:
 424         description: >-
 425           number of octets per second written to a disk or partition; provide
 426           the minimum measurement within the measurement interval
 427         type: number
 428       diskOpsReadAvg:
 429         description: >-
 430           number of read operations per second issued to the disk; provide the
 431           average measurement within the measurement interval
 432         type: number
 433       diskOpsReadLast:
 434         description: >-
 435           number of read operations per second issued to the disk; provide the
 436           last measurement within the measurement interval
 437         type: number
 438       diskOpsReadMax:
 439         description: >-
 440           number of read operations per second issued to the disk; provide the
 441           maximum measurement within the measurement interval
 442         type: number
 443       diskOpsReadMin:
 444         description: >-
 445           number of read operations per second issued to the disk; provide the
 446           minimum measurement within the measurement interval
 447         type: number
 448       diskOpsWriteAvg:
 449         description: >-
 450           number of write operations per second issued to the disk; provide the
 451           average measurement within the measurement interval
 452         type: number
 453       diskOpsWriteLast:
 454         description: >-
 455           number of write operations per second issued to the disk; provide the
 456           last measurement within the measurement interval
 457         type: number
 458       diskOpsWriteMax:
 459         description: >-
 460           number of write operations per second issued to the disk; provide the
 461           maximum measurement within the measurement interval
 462         type: number
 463       diskOpsWriteMin:
 464         description: >-
 465           number of write operations per second issued to the disk; provide the
 466           minimum measurement within the measurement interval
 467         type: number
 468       diskPendingOperationsAvg:
 469         description: >-
 470           queue size of pending I/O operations per second; provide the average
 471           measurement within the measurement interval
 472         type: number
 473       diskPendingOperationsLast:
 474         description: >-
 475           queue size of pending I/O operations per second; provide the last
 476           measurement within the measurement interval
 477         type: number
 478       diskPendingOperationsMax:
 479         description: >-
 480           queue size of pending I/O operations per second; provide the maximum
 481           measurement within the measurement interval
 482         type: number
 483       diskPendingOperationsMin:
 484         description: >-
 485           queue size of pending I/O operations per second; provide the minimum
 486           measurement within the measurement interval
 487         type: number
 488       diskTimeReadAvg:
 489         description: >-
 490           milliseconds a read operation took to complete; provide the average
 491           measurement within the measurement interval
 492         type: number
 493       diskTimeReadLast:
 494         description: >-
 495           milliseconds a read operation took to complete; provide the last
 496           measurement within the measurement interval
 497         type: number
 498       diskTimeReadMax:
 499         description: >-
 500           milliseconds a read operation took to complete; provide the maximum
 501           measurement within the measurement interval
 502         type: number
 503       diskTimeReadMin:
 504         description: >-
 505           milliseconds a read operation took to complete; provide the minimum
 506           measurement within the measurement interval
 507         type: number
 508       diskTimeWriteAvg:
 509         description: >-
 510           milliseconds a write operation took to complete; provide the average
 511           measurement within the measurement interval
 512         type: number
 513       diskTimeWriteLast:
 514         description: >-
 515           milliseconds a write operation took to complete; provide the last
 516           measurement within the measurement interval
 517         type: number
 518       diskTimeWriteMax:
 519         description: >-
 520           milliseconds a write operation took to complete; provide the maximum
 521           measurement within the measurement interval
 522         type: number
 523       diskTimeWriteMin:
 524         description: >-
 525           milliseconds a write operation took to complete; provide the minimum
 526           measurement within the measurement interval
 527         type: number
 528     required:
 529       - diskIdentifier
 530   endOfCallVqmSummaries:
 531     description: provides end of call voice quality metrics
 532     type: object
 533     properties:
 534       adjacencyName:
 535         description: ' adjacency name'
 536         type: string
 537       endpointDescription:
 538         description: Either Caller or Callee
 539         type: string
 540         enum:
 541           - Caller
 542           - Callee
 543       endpointJitter:
 544         description: ''
 545         type: number
 546       endpointRtpOctetsDiscarded:
 547         description: ''
 548         type: number
 549       endpointRtpOctetsReceived:
 550         description: ''
 551         type: number
 552       endpointRtpOctetsSent:
 553         description: ''
 554         type: number
 555       endpointRtpPacketsDiscarded:
 556         description: ''
 557         type: number
 558       endpointRtpPacketsReceived:
 559         description: ''
 560         type: number
 561       endpointRtpPacketsSent:
 562         description: ''
 563         type: number
 564       localJitter:
 565         description: ''
 566         type: number
 567       localRtpOctetsDiscarded:
 568         description: ''
 569         type: number
 570       localRtpOctetsReceived:
 571         description: ''
 572         type: number
 573       localRtpOctetsSent:
 574         description: ''
 575         type: number
 576       localRtpPacketsDiscarded:
 577         description: ''
 578         type: number
 579       localRtpPacketsReceived:
 580         description: ''
 581         type: number
 582       localRtpPacketsSent:
 583         description: ''
 584         type: number
 585       mosCqe:
 586         description: 1-5 1dp
 587         type: number
 588       packetsLost:
 589         description: ''
 590         type: number
 591       packetLossPercent:
 592         description: >-
 593           Calculated percentage packet loss based on Endpoint RTP packets lost
 594           (as reported in RTCP) and Local RTP packets sent. Direction is based
 595           on Endpoint description (Caller, Callee). Decimal (2 dp)
 596         type: number
 597       rFactor:
 598         description: 0-100
 599         type: number
 600       roundTripDelay:
 601         description: millisecs
 602         type: number
 603     required:
 604       - adjacencyName
 605       - endpointDescription
 606   event:
 607     description: the root level of the common event format
 608     type: object
 609     properties:
 610       commonEventHeader:
 611         $ref: '#/definitions/commonEventHeader'
 612       faultFields:
 613         $ref: '#/definitions/faultFields'
 614       heartbeatFields:
 615         $ref: '#/definitions/heartbeatFields'
 616       measurementsForVfScalingFields:
 617         $ref: '#/definitions/measurementsForVfScalingFields'
 618       mobileFlowFields:
 619         $ref: '#/definitions/mobileFlowFields'
 620       otherFields:
 621         $ref: '#/definitions/otherFields'
 622       sipSignalingFields:
 623         $ref: '#/definitions/sipSignalingFields'
 624       stateChangeFields:
 625         $ref: '#/definitions/stateChangeFields'
 626       syslogFields:
 627         $ref: '#/definitions/syslogFields'
 628       thresholdCrossingAlertFields:
 629         $ref: '#/definitions/thresholdCrossingAlertFields'
 630       voiceQualityFields:
 631         $ref: '#/definitions/voiceQualityFields'
 632     required:
 633       - commonEventHeader
 634   eventDomainThrottleSpecification:
 635     description: specification of what information to suppress within an event domain
 636     type: object
 637     properties:
 638       eventDomain:
 639         description: Event domain enum from the commonEventHeader domain field
 640         type: string
 641       suppressedFieldNames:
 642         description: >-
 643           List of optional field names in the event block that should not be
 644           sent to the Event Listener
 645         type: array
 646         items:
 647           type: string
 648       suppressedNvPairsList:
 649         description: >-
 650           Optional list of specific NvPairsNames to suppress within a given
 651           Name-Value Field
 652         type: array
 653         items:
 654           $ref: '#/definitions/suppressedNvPairs'
 655     required:
 656       - eventDomain
 657   eventDomainThrottleSpecificationList:
 658     description: array of eventDomainThrottleSpecifications
 659     type: array
 660     items:
 661       $ref: '#/definitions/eventDomainThrottleSpecification'
 662     minItems: 0
 663   eventList:
 664     description: array of events
 665     type: array
 666     items:
 667       $ref: '#/definitions/event'
 668   faultFields:
 669     description: fields specific to fault events
 670     type: object
 671     properties:
 672       alarmAdditionalInformation:
 673         description: additional alarm information
 674         type: array
 675         items:
 676           $ref: '#/definitions/field'
 677       alarmCondition:
 678         description: alarm condition reported by the device
 679         type: string
 680       alarmInterfaceA:
 681         description: >-
 682           card, port, channel or interface name of the device generating the
 683           alarm
 684         type: string
 685       eventCategory:
 686         description: >-
 687           Event category, for example: license, link, routing, security,
 688           signaling
 689         type: string
 690       eventSeverity:
 691         description: event severity
 692         type: string
 693         enum:
 694           - CRITICAL
 695           - MAJOR
 696           - MINOR
 697           - WARNING
 698           - NORMAL
 699       eventSourceType:
 700         description: >-
 701           type of event source; examples: card, host, other, port,
 702           portThreshold, router, slotThreshold, switch, virtualMachine,
 703           virtualNetworkFunction
 704         type: string
 705       faultFieldsVersion:
 706         description: version of the faultFields block
 707         type: number
 708       specificProblem:
 709         description: short description of the alarm or problem
 710         type: string
 711       vfStatus:
 712         description: virtual function status enumeration
 713         type: string
 714         enum:
 715           - Active
 716           - Idle
 717           - Preparing to terminate
 718           - Ready to terminate
 719           - Requesting termination
 720     required:
 721       - alarmCondition
 722       - eventSeverity
 723       - eventSourceType
 724       - faultFieldsVersion
 725       - specificProblem
 726       - vfStatus
 727   featuresInUse:
 728     description: >-
 729       number of times an identified feature was used over the
 730       measurementInterval
 731     type: object
 732     properties:
 733       featureIdentifier:
 734         type: string
 735       featureUtilization:
 736         type: integer
 737     required:
 738       - featureIdentifier
 739       - featureUtilization
 740   field:
 741     description: name value pair
 742     type: object
 743     properties:
 744       name:
 745         type: string
 746       value:
 747         type: string
 748     required:
 749       - name
 750       - value
 751   filesystemUsage:
 752     description: >-
 753       disk usage of an identified virtual machine in gigabytes and/or gigabytes
 754       per second
 755     type: object
 756     properties:
 757       blockConfigured:
 758         type: number
 759       blockIops:
 760         type: number
 761       blockUsed:
 762         type: number
 763       ephemeralConfigured:
 764         type: number
 765       ephemeralIops:
 766         type: number
 767       ephemeralUsed:
 768         type: number
 769       filesystemName:
 770         type: string
 771     required:
 772       - blockConfigured
 773       - blockIops
 774       - blockUsed
 775       - ephemeralConfigured
 776       - ephemeralIops
 777       - ephemeralUsed
 778       - filesystemName
 779   gtpPerFlowMetrics:
 780     description: Mobility GTP Protocol per flow metrics
 781     type: object
 782     properties:
 783       avgBitErrorRate:
 784         description: average bit error rate
 785         type: number
 786       avgPacketDelayVariation:
 787         description: >-
 788           Average packet delay variation or jitter in milliseconds for received
 789           packets: Average difference between the packet timestamp and time
 790           received for all pairs of consecutive packets
 791         type: number
 792       avgPacketLatency:
 793         description: average delivery latency
 794         type: number
 795       avgReceiveThroughput:
 796         description: average receive throughput
 797         type: number
 798       avgTransmitThroughput:
 799         description: average transmit throughput
 800         type: number
 801       durConnectionFailedStatus:
 802         description: >-
 803           duration of failed state in milliseconds, computed as the cumulative
 804           time between a failed echo request and the next following successful
 805           error request, over this reporting interval
 806         type: number
 807       durTunnelFailedStatus:
 808         description: >-
 809           Duration of errored state, computed as the cumulative time between a
 810           tunnel error indicator and the next following non-errored indicator,
 811           over this reporting interval
 812         type: number
 813       flowActivatedBy:
 814         description: Endpoint activating the flow
 815         type: string
 816       flowActivationEpoch:
 817         description: >-
 818           Time the connection is activated in the flow (connection) being
 819           reported on, or transmission time of the first packet if activation
 820           time is not available
 821         type: number
 822       flowActivationMicrosec:
 823         description: Integer microseconds for the start of the flow connection
 824         type: number
 825       flowActivationTime:
 826         description: >-
 827           time the connection is activated in the flow being reported on, or
 828           transmission time of the first packet if activation time is not
 829           available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05
 830           -0800
 831         type: string
 832       flowDeactivatedBy:
 833         description: Endpoint deactivating the flow
 834         type: string
 835       flowDeactivationEpoch:
 836         description: >-
 837           Time for the start of the flow connection, in integer UTC epoch time
 838           aka UNIX time
 839         type: number
 840       flowDeactivationMicrosec:
 841         description: Integer microseconds for the start of the flow connection
 842         type: number
 843       flowDeactivationTime:
 844         description: >-
 845           Transmission time of the first packet in the flow connection being
 846           reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05
 847           -0800
 848         type: string
 849       flowStatus:
 850         description: >-
 851           connection status at reporting time as a working / inactive / failed
 852           indicator value
 853         type: string
 854       gtpConnectionStatus:
 855         description: Current connection state at reporting time
 856         type: string
 857       gtpTunnelStatus:
 858         description: Current tunnel state  at reporting time
 859         type: string
 860       ipTosCountList:
 861         description: >-
 862           array of key: value pairs where the keys are drawn from the IP
 863           Type-of-Service identifiers which range from '0' to '255', and the
 864           values are the count of packets that had those ToS identifiers in the
 865           flow
 866         type: array
 867         items:
 868           type: array
 869           items:
 870             type: string
 871             type: number
 872       ipTosList:
 873         description: >-
 874           Array of unique IP Type-of-Service values observed in the flow where
 875           values range from '0' to '255'
 876         type: array
 877         items:
 878           type: string
 879       largePacketRtt:
 880         description: large packet round trip time
 881         type: number
 882       largePacketThreshold:
 883         description: large packet threshold being applied
 884         type: number
 885       maxPacketDelayVariation:
 886         description: >-
 887           Maximum packet delay variation or jitter in milliseconds for received
 888           packets: Maximum of the difference between the packet timestamp and
 889           time received for all pairs of consecutive packets
 890         type: number
 891       maxReceiveBitRate:
 892         description: maximum receive bit rate
 893         type: number
 894       maxTransmitBitRate:
 895         description: maximum transmit bit rate
 896         type: number
 897       mobileQciCosCountList:
 898         description: >-
 899           array of key: value pairs where the keys are drawn from LTE QCI or
 900           UMTS class of service strings, and the values are the count of packets
 901           that had those strings in the flow
 902         type: array
 903         items:
 904           type: array
 905           items:
 906             type: string
 907             type: number
 908       mobileQciCosList:
 909         description: >-
 910           Array of unique LTE QCI or UMTS class-of-service values observed in
 911           the flow
 912         type: array
 913         items:
 914           type: string
 915       numActivationFailures:
 916         description: >-
 917           Number of failed activation requests, as observed by the reporting
 918           node
 919         type: number
 920       numBitErrors:
 921         description: number of errored bits
 922         type: number
 923       numBytesReceived:
 924         description: 'number of bytes received, including retransmissions'
 925         type: number
 926       numBytesTransmitted:
 927         description: 'number of bytes transmitted, including retransmissions'
 928         type: number
 929       numDroppedPackets:
 930         description: number of received packets dropped due to errors per virtual interface
 931         type: number
 932       numGtpEchoFailures:
 933         description: >-
 934           Number of Echo request path failures where failed paths are defined in
 935           3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2
 936         type: number
 937       numGtpTunnelErrors:
 938         description: >-
 939           Number of tunnel error indications where errors are defined in 3GPP TS
 940           29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1
 941         type: number
 942       numHttpErrors:
 943         description: Http error count
 944         type: number
 945       numL7BytesReceived:
 946         description: 'number of tunneled layer 7 bytes received, including retransmissions'
 947         type: number
 948       numL7BytesTransmitted:
 949         description: >-
 950           number of tunneled layer 7 bytes transmitted, excluding
 951           retransmissions
 952         type: number
 953       numLostPackets:
 954         description: number of lost packets
 955         type: number
 956       numOutOfOrderPackets:
 957         description: number of out-of-order packets
 958         type: number
 959       numPacketErrors:
 960         description: number of errored packets
 961         type: number
 962       numPacketsReceivedExclRetrans:
 963         description: 'number of packets received, excluding retransmission'
 964         type: number
 965       numPacketsReceivedInclRetrans:
 966         description: 'number of packets received, including retransmission'
 967         type: number
 968       numPacketsTransmittedInclRetrans:
 969         description: 'number of packets transmitted, including retransmissions'
 970         type: number
 971       numRetries:
 972         description: number of packet retries
 973         type: number
 974       numTimeouts:
 975         description: number of packet timeouts
 976         type: number
 977       numTunneledL7BytesReceived:
 978         description: 'number of tunneled layer 7 bytes received, excluding retransmissions'
 979         type: number
 980       roundTripTime:
 981         description: round trip time
 982         type: number
 983       tcpFlagCountList:
 984         description: >-
 985           array of key: value pairs where the keys are drawn from TCP Flags and
 986           the values are the count of packets that had that TCP Flag in the flow
 987         type: array
 988         items:
 989           type: array
 990           items:
 991             type: string
 992             type: number
 993       tcpFlagList:
 994         description: Array of unique TCP Flags observed in the flow
 995         type: array
 996         items:
 997           type: string
 998       timeToFirstByte:
 999         description: >-
1000           Time in milliseconds between the connection activation and first byte
1001           received
1002         type: number
1003     required:
1004       - avgBitErrorRate
1005       - avgPacketDelayVariation
1006       - avgPacketLatency
1007       - avgReceiveThroughput
1008       - avgTransmitThroughput
1009       - flowActivationEpoch
1010       - flowActivationMicrosec
1011       - flowDeactivationEpoch
1012       - flowDeactivationMicrosec
1013       - flowDeactivationTime
1014       - flowStatus
1015       - maxPacketDelayVariation
1016       - numActivationFailures
1017       - numBitErrors
1018       - numBytesReceived
1019       - numBytesTransmitted
1020       - numDroppedPackets
1021       - numL7BytesReceived
1022       - numL7BytesTransmitted
1023       - numLostPackets
1024       - numOutOfOrderPackets
1025       - numPacketErrors
1026       - numPacketsReceivedExclRetrans
1027       - numPacketsReceivedInclRetrans
1028       - numPacketsTransmittedInclRetrans
1029       - numRetries
1030       - numTimeouts
1031       - numTunneledL7BytesReceived
1032       - roundTripTime
1033       - timeToFirstByte
1034   heartbeatFields:
1035     description: optional field block for fields specific to heartbeat events
1036     type: object
1037     properties:
1038       additionalFields:
1039         description: additional heartbeat fields if needed
1040         type: array
1041         items:
1042           $ref: '#/definitions/field'
1043       heartbeatFieldsVersion:
1044         description: version of the heartbeatFields block
1045         type: number
1046       heartbeatInterval:
1047         description: current heartbeat interval in seconds
1048         type: integer
1049     required:
1050       - heartbeatFieldsVersion
1051       - heartbeatInterval
1052   internalHeaderFields:
1053     description: >-
1054       enrichment fields for internal VES Event Listener service use only, not
1055       supplied by event sources
1056     type: object
1057   jsonObject:
1058     description: >-
1059       json object schema, name and other meta-information along with one or more
1060       object instances
1061     type: object
1062     properties:
1063       objectInstances:
1064         description: one or more instances of the jsonObject
1065         type: array
1066         items:
1067           $ref: '#/definitions/jsonObjectInstance'
1068       objectName:
1069         description: name of the JSON Object
1070         type: string
1071       objectSchema:
1072         description: json schema for the object
1073         type: string
1074       objectSchemaUrl:
1075         description: Url to the json schema for the object
1076         type: string
1077       nfSubscribedObjectName:
1078         description: name of the object associated with the nfSubscriptonId
1079         type: string
1080       nfSubscriptionId:
1081         description: >-
1082           identifies an openConfig telemetry subscription on a network function,
1083           which configures the network function to send complex object data
1084           associated with the jsonObject
1085         type: string
1086     required:
1087       - objectInstances
1088       - objectName
1089   jsonObjectInstance:
1090     description: >-
1091       meta-information about an instance of a jsonObject along with the actual
1092       object instance
1093     type: object
1094     properties:
1095       objectInstance:
1096         description: an instance conforming to the jsonObject schema
1097         type: object
1098       objectInstanceEpochMicrosec:
1099         description: >-
1100           the unix time aka epoch time associated with this objectInstance--as
1101           microseconds elapsed since 1 Jan 1970 not including leap seconds
1102         type: number
1103       objectKeys:
1104         description: >-
1105           an ordered set of keys that identifies this particular instance of
1106           jsonObject
1107         type: array
1108         items:
1109           $ref: '#/definitions/key'
1110     required:
1111       - objectInstance
1112   key:
1113     description: >-
1114       tuple which provides the name of a key along with its value and relative
1115       order
1116     type: object
1117     properties:
1118       keyName:
1119         description: name of the key
1120         type: string
1121       keyOrder:
1122         description: relative sequence or order of the key with respect to other keys
1123         type: integer
1124       keyValue:
1125         description: value of the key
1126         type: string
1127     required:
1128       - keyName
1129   latencyBucketMeasure:
1130     description: number of counts falling within a defined latency bucket
1131     type: object
1132     properties:
1133       countsInTheBucket:
1134         type: number
1135       highEndOfLatencyBucket:
1136         type: number
1137       lowEndOfLatencyBucket:
1138         type: number
1139     required:
1140       - countsInTheBucket
1141   measurementsForVfScalingFields:
1142     description: measurementsForVfScaling fields
1143     type: object
1144     properties:
1145       additionalFields:
1146         description: additional name-value-pair fields
1147         type: array
1148         items:
1149           $ref: '#/definitions/field'
1150       additionalMeasurements:
1151         description: array of named name-value-pair arrays
1152         type: array
1153         items:
1154           $ref: '#/definitions/namedArrayOfFields'
1155       additionalObjects:
1156         description: >-
1157           array of JSON objects described by name, schema and other
1158           meta-information
1159         type: array
1160         items:
1161           $ref: '#/definitions/jsonObject'
1162       codecUsageArray:
1163         description: array of codecs in use
1164         type: array
1165         items:
1166           $ref: '#/definitions/codecsInUse'
1167       concurrentSessions:
1168         description: >-
1169           peak concurrent sessions for the VM or VNF over the
1170           measurementInterval
1171         type: integer
1172       configuredEntities:
1173         description: >-
1174           over the measurementInterval, peak total number of: users,
1175           subscribers, devices, adjacencies, etc., for the VM, or subscribers,
1176           devices, etc., for the VNF
1177         type: integer
1178       cpuUsageArray:
1179         description: usage of an array of CPUs
1180         type: array
1181         items:
1182           $ref: '#/definitions/cpuUsage'
1183       diskUsageArray:
1184         description: usage of an array of disks
1185         type: array
1186         items:
1187           $ref: '#/definitions/diskUsage'
1188       featureUsageArray:
1189         description: array of features in use
1190         type: array
1191         items:
1192           $ref: '#/definitions/featuresInUse'
1193       filesystemUsageArray:
1194         description: >-
1195           filesystem usage of the VM on which the VNFC reporting the event is
1196           running
1197         type: array
1198         items:
1199           $ref: '#/definitions/filesystemUsage'
1200       latencyDistribution:
1201         description: >-
1202           array of integers representing counts of requests whose latency in
1203           milliseconds falls within per-VNF configured ranges
1204         type: array
1205         items:
1206           $ref: '#/definitions/latencyBucketMeasure'
1207       meanRequestLatency:
1208         description: >-
1209           mean seconds required to respond to each request for the VM on which
1210           the VNFC reporting the event is running
1211         type: number
1212       measurementInterval:
1213         description: interval over which measurements are being reported in seconds
1214         type: number
1215       measurementsForVfScalingVersion:
1216         description: version of the measurementsForVfScaling block
1217         type: number
1218       memoryUsageArray:
1219         description: memory usage of an array of VMs
1220         type: array
1221         items:
1222           $ref: '#/definitions/memoryUsage'
1223       numberOfMediaPortsInUse:
1224         description: number of media ports in use
1225         type: integer
1226       requestRate:
1227         description: >-
1228           peak rate of service requests per second to the VNF over the
1229           measurementInterval
1230         type: number
1231       vnfcScalingMetric:
1232         description: represents busy-ness of the VNF from 0 to 100 as reported by the VNFC
1233         type: integer
1234       vNicPerformanceArray:
1235         description: usage of an array of virtual network interface cards
1236         type: array
1237         items:
1238           $ref: '#/definitions/vNicPerformance'
1239     required:
1240       - measurementInterval
1241       - measurementsForVfScalingVersion
1242   memoryUsage:
1243     description: memory usage of an identified virtual machine
1244     type: object
1245     properties:
1246       memoryBuffered:
1247         description: kibibytes of temporary storage for raw disk blocks
1248         type: number
1249       memoryCached:
1250         description: kibibytes of memory used for cache
1251         type: number
1252       memoryConfigured:
1253         description: >-
1254           kibibytes of memory configured in the virtual machine on which the
1255           VNFC reporting the event is running
1256         type: number
1257       memoryFree:
1258         description: kibibytes of physical RAM left unused by the system
1259         type: number
1260       memorySlabRecl:
1261         description: >-
1262           the part of the slab that can be reclaimed such as caches measured in
1263           kibibytes
1264         type: number
1265       memorySlabUnrecl:
1266         description: >-
1267           the part of the slab that cannot be reclaimed even when lacking memory
1268           measured in kibibytes
1269         type: number
1270       memoryUsed:
1271         description: >-
1272           total memory minus the sum of free, buffered, cached and slab memory
1273           measured in kibibytes
1274         type: number
1275       vmIdentifier:
1276         description: virtual machine identifier associated with the memory metrics
1277         type: string
1278     required:
1279       - memoryFree
1280       - memoryUsed
1281       - vmIdentifier
1282   mobileFlowFields:
1283     description: mobileFlow fields
1284     type: object
1285     properties:
1286       additionalFields:
1287         description: additional mobileFlow fields if needed
1288         type: array
1289         items:
1290           $ref: '#/definitions/field'
1291       applicationType:
1292         description: Application type inferred
1293         type: string
1294       appProtocolType:
1295         description: application protocol
1296         type: string
1297       appProtocolVersion:
1298         description: application protocol version
1299         type: string
1300       cid:
1301         description: cell id
1302         type: string
1303       connectionType:
1304         description: 'Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc'
1305         type: string
1306       ecgi:
1307         description: Evolved Cell Global Id
1308         type: string
1309       flowDirection:
1310         description: >-
1311           Flow direction, indicating if the reporting node is the source of the
1312           flow or destination for the flow
1313         type: string
1314       gtpPerFlowMetrics:
1315         $ref: '#/definitions/gtpPerFlowMetrics'
1316       gtpProtocolType:
1317         description: GTP protocol
1318         type: string
1319       gtpVersion:
1320         description: GTP protocol version
1321         type: string
1322       httpHeader:
1323         description: 'HTTP request header, if the flow connects to a node referenced by HTTP'
1324         type: string
1325       imei:
1326         description: >-
1327           IMEI for the subscriber UE used in this flow, if the flow connects to
1328           a mobile device
1329         type: string
1330       imsi:
1331         description: >-
1332           IMSI for the subscriber UE used in this flow, if the flow connects to
1333           a mobile device
1334         type: string
1335       ipProtocolType:
1336         description: 'IP protocol type e.g., TCP, UDP, RTP...'
1337         type: string
1338       ipVersion:
1339         description: 'IP protocol version e.g., IPv4, IPv6'
1340         type: string
1341       lac:
1342         description: location area code
1343         type: string
1344       mcc:
1345         description: mobile country code
1346         type: string
1347       mnc:
1348         description: mobile network code
1349         type: string
1350       mobileFlowFieldsVersion:
1351         description: version of the mobileFlowFields block
1352         type: number
1353       msisdn:
1354         description: >-
1355           MSISDN for the subscriber UE used in this flow, as an integer, if the
1356           flow connects to a mobile device
1357         type: string
1358       otherEndpointIpAddress:
1359         description: >-
1360           IP address for the other endpoint, as used for the flow being reported
1361           on
1362         type: string
1363       otherEndpointPort:
1364         description: >-
1365           IP Port for the reporting entity, as used for the flow being reported
1366           on
1367         type: integer
1368       otherFunctionalRole:
1369         description: >-
1370           Functional role of the other endpoint for the flow being reported on
1371           e.g., MME, S-GW, P-GW, PCRF...
1372         type: string
1373       rac:
1374         description: routing area code
1375         type: string
1376       radioAccessTechnology:
1377         description: 'Radio Access Technology e.g., 2G, 3G, LTE'
1378         type: string
1379       reportingEndpointIpAddr:
1380         description: >-
1381           IP address for the reporting entity, as used for the flow being
1382           reported on
1383         type: string
1384       reportingEndpointPort:
1385         description: >-
1386           IP port for the reporting entity, as used for the flow being reported
1387           on
1388         type: integer
1389       sac:
1390         description: service area code
1391         type: string
1392       samplingAlgorithm:
1393         description: >-
1394           Integer identifier for the sampling algorithm or rule being applied in
1395           calculating the flow metrics if metrics are calculated based on a
1396           sample of packets, or 0 if no sampling is applied
1397         type: integer
1398       tac:
1399         description: transport area code
1400         type: string
1401       tunnelId:
1402         description: tunnel identifier
1403         type: string
1404       vlanId:
1405         description: VLAN identifier used by this flow
1406         type: string
1407     required:
1408       - flowDirection
1409       - gtpPerFlowMetrics
1410       - ipProtocolType
1411       - ipVersion
1412       - mobileFlowFieldsVersion
1413       - otherEndpointIpAddress
1414       - otherEndpointPort
1415       - reportingEndpointIpAddr
1416       - reportingEndpointPort
1417   namedArrayOfFields:
1418     description: an array of name value pairs along with a name for the array
1419     type: object
1420     properties:
1421       name:
1422         type: string
1423       arrayOfFields:
1424         description: array of name value pairs
1425         type: array
1426         items:
1427           $ref: '#/definitions/field'
1428     required:
1429       - name
1430       - arrayOfFields
1431   otherFields:
1432     description: >-
1433       fields for events belonging to the 'other' domain of the commonEventHeader
1434       domain enumeration
1435     type: object
1436     properties:
1437       hashOfNameValuePairArrays:
1438         description: array of named name-value-pair arrays
1439         type: array
1440         items:
1441           $ref: '#/definitions/namedArrayOfFields'
1442       jsonObjects:
1443         description: >-
1444           array of JSON objects described by name, schema and other
1445           meta-information
1446         type: array
1447         items:
1448           $ref: '#/definitions/jsonObject'
1449       nameValuePairs:
1450         description: array of name-value pairs
1451         type: array
1452         items:
1453           $ref: '#/definitions/field'
1454       otherFieldsVersion:
1455         description: version of the otherFields block
1456         type: number
1457     required:
1458       - otherFieldsVersion
1459   requestError:
1460     description: standard request error data structure
1461     type: object
1462     properties:
1463       messageId:
1464         description: >-
1465           Unique message identifier of the format ABCnnnn where ABC is either
1466           SVC for Service Exceptions or POL for Policy Exception
1467         type: string
1468       text:
1469         description: >-
1470           Message text, with replacement variables marked with %n, where n is an
1471           index into the list of <variables> elements, starting at 1
1472         type: string
1473       url:
1474         description: >-
1475           Hyperlink to a detailed error resource e.g., an HTML page for browser
1476           user agents
1477         type: string
1478       variables:
1479         description: >-
1480           List of zero or more strings that represent the contents of the
1481           variables used by the message text
1482         type: string
1483     required:
1484       - messageId
1485       - text
1486   sipSignalingFields:
1487     description: sip signaling fields
1488     type: object
1489     properties:
1490       additionalInformation:
1491         description: additional sip signaling fields if needed
1492         type: array
1493         items:
1494           $ref: '#/definitions/field'
1495       compressedSip:
1496         description: the full SIP request/response including headers and bodies
1497         type: string
1498       correlator:
1499         description: this is the same for all events on this call
1500         type: string
1501       localIpAddress:
1502         description: IP address on VNF
1503         type: string
1504       localPort:
1505         description: port on VNF
1506         type: string
1507       remoteIpAddress:
1508         description: IP address of peer endpoint
1509         type: string
1510       remotePort:
1511         description: port of peer endpoint
1512         type: string
1513       sipSignalingFieldsVersion:
1514         description: version of the sipSignalingFields block
1515         type: number
1516       summarySip:
1517         description: >-
1518           the SIP Method or Response (INVITE, 200 OK, BYE,
1519           etc)
1520         type: string
1521       vendorVnfNameFields:
1522         $ref: '#/definitions/vendorVnfNameFields'
1523     required:
1524       - correlator
1525       - localIpAddress
1526       - localPort
1527       - remoteIpAddress
1528       - remotePort
1529       - sipSignalingFieldsVersion
1530       - vendorVnfNameFields
1531   stateChangeFields:
1532     description: stateChange fields
1533     type: object
1534     properties:
1535       additionalFields:
1536         description: additional stateChange fields if needed
1537         type: array
1538         items:
1539           $ref: '#/definitions/field'
1540       newState:
1541         description: new state of the entity
1542         type: string
1543         enum:
1544           - inService
1545           - maintenance
1546           - outOfService
1547       oldState:
1548         description: previous state of the entity
1549         type: string
1550         enum:
1551           - inService
1552           - maintenance
1553           - outOfService
1554       stateChangeFieldsVersion:
1555         description: version of the stateChangeFields block
1556         type: number
1557       stateInterface:
1558         description: card or port name of the entity that changed state
1559         type: string
1560     required:
1561       - newState
1562       - oldState
1563       - stateChangeFieldsVersion
1564       - stateInterface
1565   suppressedNvPairs:
1566     description: >-
1567       List of specific NvPairsNames to suppress within a given Name-Value Field
1568       for event Throttling
1569     type: object
1570     properties:
1571       nvPairFieldName:
1572         description: Name of the field within which are the nvpair names to suppress
1573         type: string
1574       suppressedNvPairNames:
1575         description: Array of nvpair names to suppress within the nvpairFieldName
1576         type: array
1577         items:
1578           type: string
1579     required:
1580       - nvPairFieldName
1581       - suppressedNvPairNames
1582   syslogFields:
1583     description: sysLog fields
1584     type: object
1585     properties:
1586       additionalFields:
1587         description: >-
1588           additional syslog fields if needed provided as name=value delimited by
1589           a pipe | symbol, for example: 'name1=value1|name2=value2|'
1590         type: string
1591       eventSourceHost:
1592         description: hostname of the device
1593         type: string
1594       eventSourceType:
1595         description: >-
1596           type of event source; examples: other, router, switch, host, card,
1597           port, slotThreshold, portThreshold, virtualMachine,
1598           virtualNetworkFunction
1599         type: string
1600       syslogFacility:
1601         description: numeric code from 0 to 23 for facility--see table in documentation
1602         type: integer
1603       syslogFieldsVersion:
1604         description: version of the syslogFields block
1605         type: number
1606       syslogMsg:
1607         description: syslog message
1608         type: string
1609       syslogPri:
1610         description: 0-192 combined severity and facility
1611         type: integer
1612       syslogProc:
1613         description: identifies the application that originated the message
1614         type: string
1615       syslogProcId:
1616         description: >-
1617           a change in the value of this field indicates a discontinuity in
1618           syslog reporting
1619         type: number
1620       syslogSData:
1621         description: >-
1622           syslog structured data consisting of a structured data Id followed by
1623           a set of key value pairs
1624         type: string
1625       syslogSdId:
1626         description: 0-32 char in format name@number for example ourSDID@32473
1627         type: string
1628       syslogSev:
1629         description: >-
1630           numerical Code for  severity derived from syslogPri as remaider of
1631           syslogPri / 8
1632         type: string
1633         enum:
1634           - Alert
1635           - Critical
1636           - Debug
1637           - Emergency
1638           - Error
1639           - Info
1640           - Notice
1641           - Warning
1642       syslogTag:
1643         description: >-
1644           msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE
1645           should be used when no other value can be provided
1646         type: string
1647       syslogVer:
1648         description: >-
1649           IANA assigned version of the syslog protocol specification - typically
1650           1
1651         type: number
1652     required:
1653       - eventSourceType
1654       - syslogFieldsVersion
1655       - syslogMsg
1656       - syslogTag
1657   thresholdCrossingAlertFields:
1658     description: fields specific to threshold crossing alert events
1659     type: object
1660     properties:
1661       additionalFields:
1662         description: additional threshold crossing alert fields if needed
1663         type: array
1664         items:
1665           $ref: '#/definitions/field'
1666       additionalParameters:
1667         description: performance counters
1668         type: array
1669         items:
1670           $ref: '#/definitions/counter'
1671       alertAction:
1672         description: Event action
1673         type: string
1674         enum:
1675           - CLEAR
1676           - CONT
1677           - SET
1678       alertDescription:
1679         description: Unique short alert description such as IF-SHUB-ERRDROP
1680         type: string
1681       alertType:
1682         description: Event type
1683         type: string
1684         enum:
1685           - CARD-ANOMALY
1686           - ELEMENT-ANOMALY
1687           - INTERFACE-ANOMALY
1688           - SERVICE-ANOMALY
1689       alertValue:
1690         description: Calculated API value (if applicable)
1691         type: string
1692       associatedAlertIdList:
1693         description: List of eventIds associated with the event being reported
1694         type: array
1695         items:
1696           type: string
1697       collectionTimestamp:
1698         description: >-
1699           Time when the performance collector picked up the data; with RFC 2822
1700           compliant format: Sat, 13 Mar 2010 11:29:05 -0800
1701         type: string
1702       dataCollector:
1703         description: Specific performance collector instance used
1704         type: string
1705       elementType:
1706         description: type of network element - internal ATT field
1707         type: string
1708       eventSeverity:
1709         description: event severity or priority
1710         type: string
1711         enum:
1712           - CRITICAL
1713           - MAJOR
1714           - MINOR
1715           - WARNING
1716           - NORMAL
1717       eventStartTimestamp:
1718         description: >-
1719           Time closest to when the measurement was made; with RFC 2822 compliant
1720           format: Sat, 13 Mar 2010 11:29:05 -0800
1721         type: string
1722       interfaceName:
1723         description: Physical or logical port or card (if applicable)
1724         type: string
1725       networkService:
1726         description: network name - internal ATT field
1727         type: string
1728       possibleRootCause:
1729         description: Reserved for future use
1730         type: string
1731       thresholdCrossingFieldsVersion:
1732         description: version of the thresholdCrossingAlertFields block
1733         type: number
1734     required:
1735       - additionalParameters
1736       - alertAction
1737       - alertDescription
1738       - alertType
1739       - collectionTimestamp
1740       - eventSeverity
1741       - eventStartTimestamp
1742       - thresholdCrossingFieldsVersion
1743   vendorVnfNameFields:
1744     description: 'provides vendor, vnf and vfModule identifying information'
1745     type: object
1746     properties:
1747       vendorName:
1748         description: VNF vendor name
1749         type: string
1750       vfModuleName:
1751         description: ASDC vfModuleName for the vfModule generating the event
1752         type: string
1753       vnfName:
1754         description: ASDC modelName for the VNF generating the event
1755         type: string
1756     required:
1757       - vendorName
1758   vNicPerformance:
1759     description: >-
1760       describes the performance and errors of an identified virtual network
1761       interface card
1762     type: object
1763     properties:
1764       receivedBroadcastPacketsAccumulated:
1765         description: >-
1766           Cumulative count of broadcast packets received as read at the end of
1767           the measurement interval
1768         type: number
1769       receivedBroadcastPacketsDelta:
1770         description: Count of broadcast packets received within the measurement interval
1771         type: number
1772       receivedDiscardedPacketsAccumulated:
1773         description: >-
1774           Cumulative count of discarded packets received as read at the end of
1775           the measurement interval
1776         type: number
1777       receivedDiscardedPacketsDelta:
1778         description: Count of discarded packets received within the measurement interval
1779         type: number
1780       receivedErrorPacketsAccumulated:
1781         description: >-
1782           Cumulative count of error packets received as read at the end of the
1783           measurement interval
1784         type: number
1785       receivedErrorPacketsDelta:
1786         description: Count of error packets received within the measurement interval
1787         type: number
1788       receivedMulticastPacketsAccumulated:
1789         description: >-
1790           Cumulative count of multicast packets received as read at the end of
1791           the measurement interval
1792         type: number
1793       receivedMulticastPacketsDelta:
1794         description: Count of multicast packets received within the measurement interval
1795         type: number
1796       receivedOctetsAccumulated:
1797         description: >-
1798           Cumulative count of octets received as read at the end of the
1799           measurement interval
1800         type: number
1801       receivedOctetsDelta:
1802         description: Count of octets received within the measurement interval
1803         type: number
1804       receivedTotalPacketsAccumulated:
1805         description: >-
1806           Cumulative count of all packets received as read at the end of the
1807           measurement interval
1808         type: number
1809       receivedTotalPacketsDelta:
1810         description: Count of all packets received within the measurement interval
1811         type: number
1812       receivedUnicastPacketsAccumulated:
1813         description: >-
1814           Cumulative count of unicast packets received as read at the end of the
1815           measurement interval
1816         type: number
1817       receivedUnicastPacketsDelta:
1818         description: Count of unicast packets received within the measurement interval
1819         type: number
1820       transmittedBroadcastPacketsAccumulated:
1821         description: >-
1822           Cumulative count of broadcast packets transmitted as read at the end
1823           of the measurement interval
1824         type: number
1825       transmittedBroadcastPacketsDelta:
1826         description: Count of broadcast packets transmitted within the measurement interval
1827         type: number
1828       transmittedDiscardedPacketsAccumulated:
1829         description: >-
1830           Cumulative count of discarded packets transmitted as read at the end
1831           of the measurement interval
1832         type: number
1833       transmittedDiscardedPacketsDelta:
1834         description: Count of discarded packets transmitted within the measurement interval
1835         type: number
1836       transmittedErrorPacketsAccumulated:
1837         description: >-
1838           Cumulative count of error packets transmitted as read at the end of
1839           the measurement interval
1840         type: number
1841       transmittedErrorPacketsDelta:
1842         description: Count of error packets transmitted within the measurement interval
1843         type: number
1844       transmittedMulticastPacketsAccumulated:
1845         description: >-
1846           Cumulative count of multicast packets transmitted as read at the end
1847           of the measurement interval
1848         type: number
1849       transmittedMulticastPacketsDelta:
1850         description: Count of multicast packets transmitted within the measurement interval
1851         type: number
1852       transmittedOctetsAccumulated:
1853         description: >-
1854           Cumulative count of octets transmitted as read at the end of the
1855           measurement interval
1856         type: number
1857       transmittedOctetsDelta:
1858         description: Count of octets transmitted within the measurement interval
1859         type: number
1860       transmittedTotalPacketsAccumulated:
1861         description: >-
1862           Cumulative count of all packets transmitted as read at the end of the
1863           measurement interval
1864         type: number
1865       transmittedTotalPacketsDelta:
1866         description: Count of all packets transmitted within the measurement interval
1867         type: number
1868       transmittedUnicastPacketsAccumulated:
1869         description: >-
1870           Cumulative count of unicast packets transmitted as read at the end of
1871           the measurement interval
1872         type: number
1873       transmittedUnicastPacketsDelta:
1874         description: Count of unicast packets transmitted within the measurement interval
1875         type: number
1876       valuesAreSuspect:
1877         description: >-
1878           Indicates whether vNicPerformance values are likely inaccurate due to
1879           counter overflow or other condtions
1880         type: string
1881         enum:
1882           - 'true'
1883           - 'false'
1884       vNicIdentifier:
1885         description: vNic identification
1886         type: string
1887     required:
1888       - valuesAreSuspect
1889       - vNicIdentifier
1890   voiceQualityFields:
1891     description: provides statistics related to customer facing voice products
1892     type: object
1893     properties:
1894       additionalInformation:
1895         description: additional voice quality fields if needed
1896         type: array
1897         items:
1898           $ref: '#/definitions/field'
1899       calleeSideCodec:
1900         description: callee codec for the call
1901         type: string
1902       callerSideCodec:
1903         description: caller codec for the call
1904         type: string
1905       correlator:
1906         description: this is the same for all events on this call
1907         type: string
1908       endOfCallVqmSummaries:
1909         $ref: '#/definitions/endOfCallVqmSummaries'
1910       phoneNumber:
1911         description: phone number associated with the correlator
1912         type: string
1913       midCallRtcp:
1914         description: Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers
1915         type: string
1916       vendorVnfNameFields:
1917         $ref: '#/definitions/vendorVnfNameFields'
1918       voiceQualityFieldsVersion:
1919         description: version of the voiceQualityFields block
1920         type: number
1921     required:
1922       - calleeSideCodec
1923       - callerSideCodec
1924       - correlator
1925       - midCallRtcp
1926       - vendorVnfNameFields
1927       - voiceQualityFieldsVersion