"description":"An identifier with the intention of being globally unique.\n",
@@ -34,28 +40,43 @@
"type":"string"
}
},
"required":["type","objectId"]
"required":[
"type",
"objectId"
]
}
},
"jobCriteria":{
"description":"This type represents collection criteria for logging jobs. * NOTE:\tThe value of the loggingType has dependency on the object that is requested to be logged\n (refer to the CreateLoggingJobRequest): a) the logging of messages is only applicable to\n ManoServiceInterface and ConsumedManoInterface objects.",
"type":"object",
"required":["loggingType"],
"required":[
"loggingType"
],
"properties":{
"loggingType":{
"description":"Type of logging. This defines the types of logged information to collect.\nPermitted 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.\nSee note.",
"description":"Type of logging. This defines the types of logged information to collect.\nPermitted 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.\nSee note.",
"type":"string",
"enum":["MESSAGES","SERVICES","SYSTEM"]
"enum":[
"MESSAGES",
"SERVICES",
"SYSTEM"
]
},
"messagesLogDetail":{
"description":"This type represents criteria for logging jobs to collect logged messages on NFV-MANO service interfaces. * NOTE:\tIf a matching pattern is present, at least one of the \"srcIpAddress\", \"dstIpAddress\", \"requestMethod\",\n\"requestUriPattern\" or \"responseCodes\" shall be provided.",
"type":"object",
"required":["direction"],
"required":[
"direction"
],
"properties":{
"direction":{
"description":"The direction of the interface messages to match.\nPermitted 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"]
"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. See note.",
@@ -64,19 +85,29 @@
"type":"object",
"anyOf":[
{
"required":["srcIpAddress"]
"required":[
"srcIpAddress"
]
},
{
"required":["dstIpAddress"]
"required":[
"dstIpAddress"
]
},
{
"required":["requestMethod"]
"required":[
"requestMethod"
]
},
{
"required":["requestUriPattern"]
"required":[
"requestUriPattern"
]
},
{
"required":["responseCodes"]
"required":[
"responseCodes"
]
}
],
"properties":{
@@ -86,7 +117,7 @@
"format":"IP"
},
"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.",
"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 9110 and IETF RFC 5789. The API producer shall support this attribute.",
"type":"string"
},
"requestUriPattern":{
@@ -135,7 +166,10 @@
"systemLogDetail":{
"description":"This type represents criteria for logging jobs to collect logged system events of the NFV-MANO functional entity. * NOTE:\tThe set of properties and values for this attribute are assumed to be known to the consumer\n by means defined outside of the present document.",
"type":"object",
"required":["systemLogs","severityLevel"],
"required":[
"systemLogs",
"severityLevel"
],
"properties":{
"systemLogs":{
"description":"This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
@@ -156,7 +190,10 @@
"jobConfig":{
"description":"This type represents configuration data for a logging job. It shall comply with the provisions defined in table 8.6.3.6-1. NOTE: The present document version does not specify the support for \"log compilation and reporting based on events\" as specified in clause 6.6.2.2 of ETSI GS NFV-IFA 031.\n* NOTE 1:\tThe minimumReportingPeriod is used to throttle possible flooding of reports by providing a lower\n limit on the gap between two log availability notification to be emitted by the same logging job.\n NOTE 2:\tMore than one logCompilingCondition is possible to provide a combination of different conditions\n for the compilation. This covers use cases when the compilation of the log can be based on, e.g.\n a timer value and a size value, whichever first condition is met first. For instance, compile a\n log every 3 600 seconds, or whenever during the 3 600 seconds period the log grows in\n size to 1 000 000 bytes.\n NOTE 3:\tThe value is indicative, as the actual size of the compiled log files might not match the provided\n compileBySizeValue due to possible deviations in the tracking of the size of the log data by the\n API producer, and the size of individual logged data entries when these are collected.",
"type":"object",
"required":["reportingCondition","securityConf"],
"required":[
"reportingCondition",
"securityConf"
],
"properties":{
"startTime":{
"description":"Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
@@ -170,12 +207,17 @@
},
"reportingCondition":{
"description":"Specifies the condition under which the producer will report to the consumer about the compiled log data.",
"required":["reportingType"],
"required":[
"reportingType"
],
"properties":{
"reportingType":{
"description":"Specifies the type of reporting condition. Permitted values: - REPORTING_ON_COMPILATION: the producer shall notify the consumer once the compilation of the\n collected logging data into a file is completed and a new log report is available.\n- NO_REPORTING: no reporting is requested (the consumer can query the logging jobs to know about the\n availability of new log reports).",
"description":"Specifies the minimum periodicity at which the producer will report to the consumer about the collected log information, in seconds. See note 1.",
@@ -200,7 +242,10 @@
"properties":{
"logFileEncryption":{
"description":"Information about the encryption of the compiled log files. Shall be present if the log file is requested to be encrypted.",
