WARNING! Gitlab maintenance operation scheduled for Monday, 20 April between 12:00 and 14:00 (CET). During this time window, short service interruptions (less than 5 minutes) may occur. Thank you in advance for your understanding.
"description":"This notification informs the receiver that performance information is available. The timing of sending this notification is determined by the capability of the producing entity to evaluate the threshold crossing condition. The notification shall be triggered by the VNFM when new performance information collected by a PM job is available.\n",
"description":"This notification informs the receiver that performance information is available.\n",
"type":"object",
"required":[
"id",
"notificationType",
"subscriptionId",
"pmJobId",
"timeStamp",
"objectType",
"objectInstanceId",
"_links"
],
@@ -15,14 +16,7 @@
"type":"string"
},
"notificationType":{
"description":"Discriminator for the different notification types. Shall be set to \"PerformanceInformationAvailableNotification\" for this notification type.\n",
"type":"string",
"enum":[
"PerformanceInformationAvailableNotification"
]
},
"subscriptionId":{
"description":"An identifier with the intention of being globally unique.\n",
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"timeStamp":{
@@ -30,76 +24,70 @@
"type":"string",
"format":"date-time"
},
"pmJobId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"objectType":{
"description":"A string defined in IETF RFC 8259.\n",
"type":"string"
},
"objectInstanceId":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"subObjectInstanceId":{
"description":"An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n",
"type":"string"
},
"_links":{
"description":"Links to resources related to this notification.\n",
"type":"object",
"required":[
"subscription",
"pmJob",
"performanceReport"
],
"properties":{
"subscription":{
"description":"This type represents a link to a resource.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
}
}
},
"objectInstance":{
"description":"This type represents a link to a resource.\n",
"description":"This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
}
},
"pmJob":{
"description":"This type represents a link to a resource.\n",
"description":"This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
}
}
},
"performanceReport":{
"description":"This type represents a link to a resource.\n",
"PerformanceReport":{
"description":"This type represents a link to a resource in a notification, using an absolute or relative URI.\n",
"type":"object",
"required":[
"href"
],
"properties":{
"href":{
"description":"URI of the referenced resource.\n",
"type":"string",
"format":"url"
}
"description":"String formatted according to IETF RFC 3986.\n",
"description":"This type defines the format of a performance report provided by the NFV-MANO functional entity to the API consumer as a result of collecting performance information as part of a PM job. \n",
"type":"object",
"required":[
"entries"
],
"properties":{
"entries":{
"description":"List of performance information entries. Each performance report entry is for a given metric of a given object (i.e. measured object instance) corresponding to the related measured object types, but can include multiple collected values.\n",
"description":"This type represents a PM job. \n",
"type":"object",
"required":[
"id",
"objectType",
"objectInstanceIds",
"criteria",
"_links",
"callbackUri"
],
"properties":{
"id":{
"description":"An identifier with the intention of being globally unique.\n",
@@ -28,29 +36,33 @@
}
},
"criteria":{
"description":"This type represents collection criteria for PM jobs.\n",
"description":"This type represents collection criteria for PM jobs. * NOTE 1:\tAt the end of each reportingPeriod, the producer will inform the API consumer about availability\n of the performance data collected for each completed collection period during this reportingPeriod.\n The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case,\n the performance data for the collection periods within one reporting period are reported together.\n* NOTE 2:\tIn particular when choosing short collection and reporting periods, the number of PM jobs that can\n be supported depends on the capability of the producing entity.\n",
"type":"object",
"required":[
"collectionPeriod",
"reportingPeriod"
],
"properties":{
"performanceMetric":{
"description":"This defines the types of performance metrics for the specified measured object(s). This attribute’s value shall contain the related \"Measurement Name\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"description":"This defines the types of performance metrics for the specified measured object(s). This attributeΓÇÖs value shall contain the related \"Measurement Name\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"type":"array",
"items":{
"type":"string"
}
},
"performanceMetricGroup":{
"description":"Group of performance metrics. A metric group is a pre-defined list of metrics, known to the producer that it can decompose to individual metrics. This attribute’s value shall contain the related \"Measurement Group\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"description":"Group of performance metrics. A metric group is a pre-defined list of metrics, known to the producer that it can decompose to individual metrics. This attributeΓÇÖs value shall contain the related \"Measurement Group\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"type":"array",
"items":{
"type":"string"
}
},
"collectionPeriod":{
"description":"Specifies the periodicity at which the producer will collect performance information. The unit shall be seconds. \nAt the end of each reportingPeriod, the producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. \nIn particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity.\n",
"description":"Specifies the periodicity at which the producer will collect performance information. The unit shall be seconds. See note 1 and note 2.\n",
"type":"integer"
},
"reportingPeriod":{
"description":"Specifies the periodicity at which the producer will report to the API consumer about performance information. The unit shall be seconds.\nAt the end of each reportingPeriod, the producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. \nIn particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity.\n",
"description":"Specifies the periodicity at which the producer will report to the API consumer about performance information. The unit shall be seconds. See note 1 and note 2.\n",
"type":"integer"
},
"reportingBoundary":{
@@ -58,11 +70,11 @@
"type":"string",
"format":"date-time"
}
}
},
"required":[
"collectionPeriod",
"reportingPeriod"
]
"callbackUri":{
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
},
"reports":{
"description":"Information about available reports collected by this PM job.\n",
"description":"This type represents a PM job. \n",
"type":"object",
"required":[
"id",
"objectType",
"objectInstanceIds",
"criteria",
"_links",
"callbackUri"
],
"properties":{
"id":{
"description":"An identifier with the intention of being globally unique.\n",
@@ -30,29 +38,33 @@
}
},
"criteria":{
"description":"This type represents collection criteria for PM jobs.\n",
"description":"This type represents collection criteria for PM jobs. * NOTE 1:\tAt the end of each reportingPeriod, the producer will inform the API consumer about availability\n of the performance data collected for each completed collection period during this reportingPeriod.\n The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case,\n the performance data for the collection periods within one reporting period are reported together.\n* NOTE 2:\tIn particular when choosing short collection and reporting periods, the number of PM jobs that can\n be supported depends on the capability of the producing entity.\n",
"type":"object",
"required":[
"collectionPeriod",
"reportingPeriod"
],
"properties":{
"performanceMetric":{
"description":"This defines the types of performance metrics for the specified measured object(s). This attribute’s value shall contain the related \"Measurement Name\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"description":"This defines the types of performance metrics for the specified measured object(s). This attributeΓÇÖs value shall contain the related \"Measurement Name\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"type":"array",
"items":{
"type":"string"
}
},
"performanceMetricGroup":{
"description":"Group of performance metrics. A metric group is a pre-defined list of metrics, known to the producer that it can decompose to individual metrics. This attribute’s value shall contain the related \"Measurement Group\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"description":"Group of performance metrics. A metric group is a pre-defined list of metrics, known to the producer that it can decompose to individual metrics. This attributeΓÇÖs value shall contain the related \"Measurement Group\" values as defined in clause 8.4 of ETSI GS NFV-IFA 031. At least one of the two attributes (performance metric or group) shall be present.\n",
"type":"array",
"items":{
"type":"string"
}
},
"collectionPeriod":{
"description":"Specifies the periodicity at which the producer will collect performance information. The unit shall be seconds. \nAt the end of each reportingPeriod, the producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. \nIn particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity.\n",
"description":"Specifies the periodicity at which the producer will collect performance information. The unit shall be seconds. See note 1 and note 2.\n",
"type":"integer"
},
"reportingPeriod":{
"description":"Specifies the periodicity at which the producer will report to the API consumer about performance information. The unit shall be seconds.\nAt the end of each reportingPeriod, the producer will inform the API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. \nIn particular when choosing short collection and reporting periods, the number of PM jobs that can be supported depends on the capability of the producing entity.\n",
"description":"Specifies the periodicity at which the producer will report to the API consumer about performance information. The unit shall be seconds. See note 1 and note 2.\n",
"type":"integer"
},
"reportingBoundary":{
@@ -60,11 +72,11 @@
"type":"string",
"format":"date-time"
}
}
},
"required":[
"collectionPeriod",
"reportingPeriod"
]
"callbackUri":{
"description":"String formatted according to IETF RFC 3986.\n",
"type":"string"
},
"reports":{
"description":"Information about available reports collected by this PM job.\n",
{"description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n","type":"object","required":["status","detail"],"properties":{"type":{"description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n","type":"string","format":"URI"},"title":{"description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n","type":"string"},"status":{"description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.\n","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n","type":"string","format":"URI"}}}
No newline at end of file
{
"description":"The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type":"object",
"required":["status","detail"],
"properties":{
"type":{
"description":"A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type":"string",
"format":"URI"
},
"title":{
"description":"A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type":"string"
},
"status":{
"description":"The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type":"integer"
},
"detail":{
"description":"A human-readable explanation specific to this occurrence of the problem.\n",
"type":"string"
},
"instance":{
"description":"A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
