Newer
Older
info:
title: SOL009 - NFV-MANO Log Management interface
SOL009 - NFV-MANO Log Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
description: ETSI GS NFV-SOL 009 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
servers:
- url: http://127.0.0.1/nfvmanologm/v1
- url: https://127.0.0.1/nfvmanologm/v1
paths:
"/api_versions":
$ref: '../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions'
"/log_jobs":
description: >-
This resource represents logging jobs. The API consumer can use this resource to create and query logging jobs.
post:
description: >-
The POST method creates a logging job. See clause 8.5.3.3.1.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateLoggingJobRequest"
responses:
"201":
$ref: '#/components/responses/LoggingJobs.Post.201'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
The API consumer can use this method to retrieve information about logging jobs. See clause 8.5.3.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/all_fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/fields"
- $ref: "../components/SOL009_params.yaml#/components/parameters/exclude_fields"
- $ref: "#/components/parameters/exclude_default.LoggingJobs"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/LoggingJobs.Get.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
"/log_jobs/{logJobId}":
description: >-
This resource represents an individual logging job. The API consumer can use this resource to delete
and read the underlying logging job.
parameters:
- $ref: "#/components/parameters/logJobId"
The API consumer can use this method for reading an individual logging job. See clause 8.5.4.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/IndividualLoggingJob.Get.200'
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
This method terminates an individual logging job. See clause 8.5.4.3.5.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/IndividualLoggingJob.Delete.204'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
"/log_jobs/{logJobId}/log_reports/{logReportId}":
description: >-
This resource represents an individual log report. The API consumer can use this resource to read
information about a log report.
The log report provides metadata information about a log and location information of the log file
from where it can be obtained.
NOTE: The present document does not specify the mechanism how to retrieve the log files.
parameters:
- $ref: "#/components/parameters/logJobId"
The API consumer can use this method for reading an individual log report. See clause 8.5.5.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/LogReport.Get.200'
$ref: '#/components/responses/LogReport.Get.202'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
"/log_jobs/{logJobId}/compile_log":
description: >-
This resource represents the "Compile log" operation. The API consumer can use this resource to request
compiling the logged data, collected via a logging job, into a file and creating the associated log report.
As the result of successfully processing this request, a new "Individual log report" resource shall be created.
Two modes of operation, synchronous or asynchronous, can take place depending on whether the NFV-MANO functional
entity can compile the log data and create the log report immediately. In the synchronous case, which is
indicated by responding with "201 Created", the resource shall be created before the "201 Created" response
is returned. In the asynchronous case, which is indicated by responding with "202 Accepted", the resource may
be created after the response is returned.
parameters:
- $ref: "#/components/parameters/logJobId"
post:
description: >-
The POST method requests to compile the logged data into a file and create an associated log report.
See clause 8.5.6.3.1.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CompileLogRequest"
responses:
"201":
$ref: '#/components/responses/LogReportCompiled.Post.201'
$ref: '#/components/responses/LogReportCompiled.Post.202'
$ref: '#/components/responses/LogReportCompiled.Post.303'
$ref: '#/components/responses/LogReportCompiled.Post.422'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
description: >-
This resource represents subscriptions. The client can use this resource to subscribe to notifications
related to NFV-MANO performance management and to query its subscriptions.
post:
description: >-
The POST method creates a new subscription. See clause 8.5.7.3.1.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: '#/components/requestBodies/LogmSubscriptionRequest'
responses:
"201":
$ref: '#/components/responses/Subscriptions.Post.201'
$ref: '#/components/responses/Subscriptions.Post.303'
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
callbacks:
LogReportAvailableNotification:
$ref: '#/components/callbacks/LogReportAvailableNotification'
get:
description: >-
The API consumer can use this method to query the list of active subscriptions to log management
notifications subscribed by the API consumer. See clause 8.5.7.3.2.
- $ref: "#/components/parameters/filter.LogmSubscriptions"
- $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
"/subscriptions/{subscriptionId}":
description: >-
This resource represents an individual subscription for notifications about log management related events.
The API consumer can use this resource to read and to terminate a subscription to notifications related
o NFV-MANO log management.
parameters:
- $ref: "#/components/parameters/subscriptionId"
get:
description: >-
The API consumer can use this method for reading an individual subscription about log management
notifications subscribed by the API consumer. See clause 8.5.8.3.2.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/Subscription.Get.200'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
This method terminates an individual subscription. See clause 8.5.8.3.5.
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
$ref: '#/components/responses/Subscription.Delete.204'
$ref: '../components/SOL009_resp.yaml#/components/responses/400'
$ref: '../components/SOL009_resp.yaml#/components/responses/401'
$ref: '../components/SOL009_resp.yaml#/components/responses/403'
$ref: '../components/SOL009_resp.yaml#/components/responses/404'
$ref: '../components/SOL009_resp.yaml#/components/responses/405'
$ref: '../components/SOL009_resp.yaml#/components/responses/406'
$ref: '../components/SOL009_resp.yaml#/components/responses/422'
$ref: '../components/SOL009_resp.yaml#/components/responses/500'
$ref: '../components/SOL009_resp.yaml#/components/responses/503'
$ref: '../components/SOL009_resp.yaml#/components/responses/504'
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
filter.LoggingJobs:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
The API consumer may supply this parameter.
All attribute names that appear in the FmSubscription and in data types referenced from it shall be supported
by the NFV-MANO functional entity in the filter expression.
in: query
required: false
schema:
type: string
exclude_default.LoggingJobs:
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
for details. The NFV-MANO functional entity shall support this parameter.
The following attributes shall be excluded from the LoggingJob structure in the response body if this parameter
is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
• logReports
in: query
required: false
schema:
type: string
filter.LogmSubscriptions:
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The NFV-MANO functional entity shall support receiving this parameter as part of the URI query string.
The API consumer may supply this parameter.
All attribute names that appear in the LogmSubscription and in data types referenced from it shall be supported
by the NFV-MANO functional entity in the filter expression.
in: query
required: false
schema:
type: string
logJobId:
name: logJobId
in: path
description: >-
Identifier of the logging job.
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
in: path
description: >-
Identifier of the report.
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
subscriptionId:
name: subscriptionId
in: path
description: >-
Identifier of the subscription
required: true
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
LogmSubscriptionRequest:
description: >-
Details of the subscription to be created
content:
application/json:
schema:
$ref: "#/components/schemas/LogmSubscriptionRequest"
CreateLoggingJobRequest:
description: >-
This type represents a request to create a logging job. It shall comply with the provisions
defined in table 8.6.2.5-1.
content:
application/json:
schema:
$ref: "#/components/schemas/CreateLoggingJobRequest"
required: true
CompileLogRequest:
description: >-
Log compilation request.
content:
application/json:
schema:
$ref: "#/components/schemas/CompileLogRequest"
required: true
LogReportAvailableNotification:
description: >-
Notification about the availability of a log report.
content:
application/json:
schema:
$ref: "#/components/schemas/LogReportAvailableNotification"
Shall be returned when the "Individual subscription" resource has been deleted successfully.
The response body shall be empty.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Shall be returned when the subscription has been read successfully.
The response body shall contain a representation of the "Individual subscription" resource,
as defined in clause 8.6.2.3.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LogmSubscription"
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
Shall be returned when the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active subscriptions of
the functional block that invokes the method, i.e. zero or more representations of log management
subscriptions as defined in clause 8.6.2.3.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have
been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the NFV-MANO functional entity supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow
the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 .
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LogmSubscription"
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
Shall be returned when the subscription has been created successfully.
A representation of the created "Individual subscription" resource shall be returned in the response body,
as defined in clause 8.6.2.3.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created
"Individual subscription" resource.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LogmSubscription"
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
Shall be returned when a subscription with the same callbackURI and the same filter already exists and the
policy of the NFV-MANO functional entity is to not create redundant subscriptions.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
"Individual subscription" resource.
The response body shall be empty.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
LogReportCompiled.Post.201:
description: >
201 CREATED
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
Shall be returned for a successful compilation of the log data and creation of the associated log report
(synchronous mode).
The response body shall contain a representation of the log report resource, as defined in clause 8.6.2.7.
The HTTP response shall include a "Location" HTTP header that indicate the URI of the
"Individual log report" resource just created
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
URI of the "Individual log report" resource just created
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LogReport"
subscriptions.post.422:
description: >
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
Shall be returned upon the following error: The content type
of the payload body is supported and the payload body of a request
contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in
clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence
of the response body.
Specifically in case of this resource, the response code 422 shall also
be returned if the API producer has tested the Notification endpoint as
described in clause 8.5.9.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure
shall convey more information about the error.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails"
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
Shall be returned when the request has been accepted for processing, and it is expected to take some
time to compile the log file and create the associated log report (asynchronous mode).
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that indicates the URI of the
"Individual log report" resource that will be created once the log file compilation is completed.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The URI of the "Individual log report" resource that will be created once the log file
compilation is completed.
schema:
type: string
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
Shall be returned when a log data compilation and report creation is already ongoing, or a log report has just been
created, for the specified logging job at the time of processing the request.
The response body shall be empty.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the log report
resource just created, or to be created by the ongoing compilation and report creation.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Location:
description: >
The URI of the log report resource just created, or to be created by the ongoing compilation
and report creation
schema:
type: string
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
including rules for the presence of the response body.
Specifically, in case of this task resource, the response code 422 shall also be returned if the
"objectInstanceId" value provided in the payload body of the request does not correspond to an object
instance for which log data is being collected by the logging job represented by this resource.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute should
convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/ProblemDetails'
Shall be returned when information of an individual log report has been read successfully.
The response body shall contain a representation of the "Individual log report" resource, as
defined in clause 8.6.2.7.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LogReport"
Shall be returned if the creation of the log report is ongoing and no log report is available yet
(applicable in asynchronous mode of the "Compile log task" resource).
The response body shall be empty.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Shall be returned when information about an individual logging job has been read successfully.
The response body shall contain a representation of the "Individual logging job" resource,
as defined in clause 8.6.2.6.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LoggingJob"
Shall be returned when the logging job has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >-
Version of the API used in the response.
schema:
type: string
The response body contains the Application Context as it was created
by the MEC system
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/LoggingJob"
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
Shall be returned when information about zero or more logging jobs has been queried successfully.
The response body shall contain in an array the representations of zero or more logging jobs, as
defined in clause 8.6.2.6.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
(if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response
body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of
ETSI GS NFV-SOL 013, respectively.
If the NFV-MANO functional entity supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall
follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LoggingJob"
Shall be returned when the notification has been delivered successfully.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
Content-Type:
description: The MIME type of the body of the response.
schema:
type: string
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
LogmSubscription:
description: >-
This type represents a subscription. It shall comply with the provisions defined in table 8.6.2.3-1.
type: object
required:
- id
- callbackUri
- _links
properties:
id:
description: >-
Identifier that identifies the subscription.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
filter:
description: >-
Filter settings for this subscription, to define the subset of all notifications this subscription
relates to. A particular notification is sent to the subscriber if the filter matches,
or if there is no filter
$ref: "#/components/schemas/LogmNotificationsFilter"
callbackUri:
description: >-
The URI of the endpoint to send the notification to.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Uri'
_links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >-
URI of this resource.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
LogmNotificationsFilter:
description: >-
This type represents a filter that can be used to subscribe for notifications related to log
management events.
* NOTE: The permitted values of the "notificationTypes" attribute are spelled exactly as the names
of the notification types to facilitate automated code generation systems.
type: object
properties:
objectInstanceFilter:
description: >-
Filter criteria to select object instance about which to notify.
$ref: "#/components/schemas/ManoEntitySubscriptionFilter"
notificationTypes:
description: >-
Match particular notification types.
Permitted values:
- LogReportAvailableNotification
type: string
enum: [LogReportAvailableNotification]
ManoEntitySubscriptionFilter:
description: >-
This type represents subscription filter criteria to match NFV-MANO functional entities and their
associated managed objects. It shall comply with the provisions defined in Table 4.3.2.2-1.
type: object
anyOf:
- oneOf:
- required:
- manoServiceIds
- required:
- manoServiceNames
- oneOf:
- required:
- manoServiceInterfaceIds
- required:
- manoServiceInterfaceNames
- oneOf:
- required:
- consumedManoInterfaceIds
- required:
- consumedManoInterfaceNames
properties:
manoEntityId:
description: >-
If present, match the NFV-MANO functional entity with an instance identifier listed in this attribute.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
manoServiceIds:
description: >-
If present, match NFV-MANO services with an instance identifier listed in this attribute.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity'
manoServiceNames:
description: >-
If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.
type: array
items:
type: string
manoServiceInterfaceIds:
description: >-
If present, match NFV-MANO functional entity produced interfaces with an instance
identifier listed in this attribute.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity'
manoServiceInterfaceNames:
description: >-
If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in
this attribute.
type: array
items:
type: string
consumedManoInterfaceIds:
description: >-
If present, match NFV-MANO functional entity consumed interfaces with an instance identifier
listed in this attribute.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
consumedManoInterfaceNames:
description: >-
If present, match NFV-MANO functional entity consumed interfaces with an instance Name
listed in this attribute.
type: array
items:
type: string
CompileLogRequest:
description: >
This type represents a request to compile the logged data associated to an object instance.
It shall comply with the provisions defined in table 8.6.2.8-1.
type: object
properties:
objectInstanceId:
description: >
Identifier of the object instance for which logging information is requested to be compiled. The provided
value shall correspond to an object instance for which log data is being collected as specified in the
corresponding "LoggingJob". If not present, the compile log request is requested for all managed object
instances associated to the logging job.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
LogReport:
description: >
This type represents a log report, which provides information about a compiled log and how to obtain it.
* NOTE: It is not specified in the present document how the NFV-MANO functional entity's private
key is provided to the NFV-MANO functional entity.
type: object
required:
- id
- objectInstanceId
- compilationTrigger
- readyTime
- fileFormat
- fileLocationInfo
- securityAndIntegrityInfo
- _links
properties:
id:
description: >-
Identifier of this log report.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
objectInstanceId:
description: >-
Identifiers of the object instance for which logging information is collected.
This attribute shall contain the identifier of the instance of the object that is
logged according to their type.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference'
compilationTrigger:
description: >-
The trigger for the compilation of the log file.
Permitted values:
- ON_DEMAND: created based on explicit request by a client.
- AUTOMATIC: created according to the logging job compilation configuration.
type: string
enum: [ON_DEMAND, AUTOMATIC]
readyTime:
description: >-
The time when the report and log file was made available.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/DateTime'
expiryTime:
description: >-
The time when the report and log file will expire.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/DateTime'
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
fileSize:
description: >-
The size of the compiled log file in bytes, if known.
type: integer
format: int32
fileFormat:
description: >-
The encoding used by the file.
type: string
fileLocationInfo:
description: >-
Location and address information of the compiled log file. The consumer can use this information
to obtain the compiled log file.
type: object
required:
- protocol
- fileEndpoint
properties:
protocol:
description: >-
Protocol over which the compiled log file can be retrieved.
Permitted values:
- HTTPS: transmission over HTTP Secure (HTTPS).
- SFTP: transmission over SSH file transfer protocol (SFTP).
- SCP: transmission over secure copy protocol (SCP).
- FTPS: transmission over file transfer protocol secure (FTPS), as specified in IETF RFC 2228,
using explicit mode as specified in IETF RFC 4217. If FTPS is supported, "private" protection level shall be used.
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
HTTPS shall be supported, and other protocols may be supported.
type: string
enum: [HTTPS, SFTP, SCP, FTPS]
fileEndpoint:
description: >-
The host name (or IP address), optionally a port number (if the host with the compile log file uses a
non-standard port number as per the supported transmission protocol), a valid file directory path,
and the file name of the compiled log file, or a valid URL.
type: string
format: URI
securityAndIntegrityInfo:
description: >-
Security and integrity information for the compilation of the log files.
type: object
required:
- algorithm
- hash
- logFileSignature
- signingCertificate
properties:
algorithm:
description: >-
Algorithm used to generate the hash of the compiled log file. Only SHA-256 and SHA-512 shall be used
type: string
hash:
description: >-
The hexadecimal value of the hash of the compiled log file. The hash shall be computed
from the encrypted compiled log file, in case the encryption applies.
type: string
encryptionPublicKey:
description: >-
Public key used for the encryption of the compiled log file. Shall be present if the
compiled log file is encrypted.
type: string
cipherAlgorithm:
description: >-
The cryptographic algorithm used for the encryption. Shall be present if the compiled log file is
encrypted. Valid values are: "AES-CBC-128", "AES-GCM-128", "AES-CBC-256", and "AES-GCM-256",
as specified in clause 6.5 of ETSI GS NFV-SEC 012.
type: string
logFileSignature:
description: >-
Signature to the compiled log file generated with the NFV-MANO functional entity’s private key,
which is used to ensure the authenticity of the compiled log file. The signature shall be applied
according to the "encryptAndSignOrder" of the "LoggingJobConfig". See note.
type: string
signingCertificate:
description: >-
X.509 certificate with the NFV-MANO functional entity’s public key used for verifying the
log report and compiled log file signatures.
type: string
_links:
description: >-
Links for this resource.
type: object
required:
- self
properties:
self:
description: >-
URI of this resource.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
objects:
description: >-
Links to resources representing the object instances that are logged. Shall be present
if the logged object instance information is accessible as a resource.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
LogmSubscriptionRequest:
description: >-
Information on application context created by the MEC system
type: object
required:
- callbackUri
type: object
properties:
filter:
description: >-
Filter settings for this subscription, to define the subset of all notifications this subscription
relates to. A particular notification is sent to the subscriber if the filter matches,
or if there is no filter.
$ref: "#/components/schemas/LogmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when sending notifications
corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires authorization of notifications.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
CreateLoggingJobRequest:
description: >-
Information on application context created by the MEC system
type: object
required:
- objectInstanceIds
- jobCriteria
- jobConfig
properties:
objectInstanceIds:
description: >-
Identifiers of the object instance for which logging information is requested to be collected.
This attribute shall contain the identifier of the instance of the object to be logged according to their type.
If more than one identifier is provided, values shall all refer to object instances of the same type,
for which the same criteria is then applicable.
type: array
minItems: 1
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
jobCriteria:
description: >-
Criteria of the collection of logging information.
$ref: "#/components/schemas/LoggingJobCriteria"
jobConfig:
description: >-
Configuration about the logging job.
$ref: "#/components/schemas/LoggingJobConfig"
LoggingJob:
description: >-
This type represents a logging job. It shall comply with the provisions defined in table 8.6.2.6-1.
type: object
required:
- id
- objectInstanceIds
- jobCriteria
- jobConfig
- _links
properties:
id:
description: >-
Identifier of this logging job.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
objectInstanceIds:
description: >-
Identifiers of the object instance for which logging information is collected. This attribute shall
contain the identifier of the instance of the object that is logged according to their type.
type: array
items:
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
jobCriteria:
description: >-
Criteria of the collection of logging information.
$ref: "#/components/schemas/LoggingJobCriteria"
jobConfig:
description: >-
Configuration about the logging job.
$ref: "#/components/schemas/LoggingJobConfig"
logReports:
description: >-
Information about available log reports created by the logging job.
type: array
items:
type: object
required:
- logReportId
- logReportLoc
properties:
logReportId:
description: >-
Identifier of the available log report.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
logReportLoc:
description: >-
Link to the available log report.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
_links:
description: >-
Links for this resource.
type: object
required:
- self
properties:
self:
description: >-
URI of this resource.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
objects:
description: >-
Links to resources representing the object instances that are logged. Shall be present
if the logged object instance information is accessible as a resource.
type: array
items:
$ref: '../components/SOL009_schemas.yaml#/components/schemas/Link'
LoggingJobCriteria:
description: >-
This type represents collection criteria for logging jobs.
* NOTE: The value of the loggingType has dependency on the object that is requested to be logged
(refer to the CreateLoggingJobRequest): a) the logging of messages is only applicable to
ManoServiceInterface and ConsumedManoInterface objects.
type: object
required:
- loggingType
properties:
loggingType:
description: >-
Type of logging. This defines the types of logged information to collect.
Permitted values:
- MESSAGES: logged NFV-MANO service interface messages.
- SERVICES: logged messages about processes pertaining to NFV-MANO services.
- SYSTEM: logged messages about the NFV-MANO functional entity’s system enabled by the provider.
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
type: string
enum: [MESSAGES, SERVICES, SYSTEM]
messagesLogDetail:
description: >-
Values for the collection of logged NFV-MANO service interface messages. Shall be
present if loggingType="MESSAGES".
type: object
$ref: "#/components/schemas/LoggingJobMessagesCriteria"
servicesLogDetail:
description: >-
Values for the collection of logged NFV-MANO service messages. Shall be present if loggingType="SERVICES".
type: object
$ref: "#/components/schemas/LoggingJobServicesCriteria"
systemLogDetail:
description: >-
Values for the collection of logged messages about the NFV-MANO functional entity’s system.
Shall be present if loggingType="SYSTEM".
type: object
$ref: "#/components/schemas/LoggingJobSystemCriteria"
LoggingJobMessagesCriteria:
description: >-
This type represents criteria for logging jobs to collect logged messages on NFV-MANO service interfaces.
* NOTE: If a matching pattern is present, at least one of the "srcIpAddress", "dstIpAddress", "requestMethod",
"requestUriPattern" or "responseCodes" shall be provided.
type: object
required:
- direction
properties:
direction:
description: >-
The direction of the interface messages to match.
Permitted values:
- IN: input messages into the interface.
- OUT: output messages from the interface.
- ALL: both input and output messages into/from the interface.
type: string
enum: [IN, OUT,ALL]
matchingPatterns:
description: >-
Patterns to be matched in the interface message. If provided, only messages that match all the
values provided in the sub-attributes shall be logged. An API consumer can provide more than one
"matchingPattern" if combinations of patterns are to be considered to match diverse sets of interface
messages.
type: array
items:
type: object
anyOf:
- required:
- srcIpAddress
- required:
- dstIpAddress
- required:
- requestMethod
- required:
- requestUriPattern
- required:
- responseCodes
properties:
srcIpAddress:
description: >-
IP address to match the source IP address of request messages to log. The API producer
shall support this attribute.
$ref: '../components/SOL009_schemas.yaml#/components/schemas/IpAddress'
requestMethod:
description: >-
HTTP request method to be matched. To match, the HTTP request method of the message shall be the
same as the value of this attribute. Valid values are specified in IETF RFC 7231. The API producer
shall support this attribute.