updated PmJob and PmJobs schemas as per NFVSOL(24)000122 (92cc5bb5) · Commits · NFV - Network Functions Virtualisation / api-tests

SOL005/NSPerformanceManagement-API/schemas/PmJob.schema.json

+176 −107

Original line number	Diff line number	Diff line
		@@ -3,24 +3,39 @@
		"type": "object",
		"required": [
		"id",
		"objectType",
		"objectInstanceIds",
		"criteria"
		"criteria",
		"callbackUri",
		"_links"
		],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"objectType": {
		"description": "A string as defined in IETF RFC 8259.\n",
		"type": "string"
		},
		"objectInstanceIds": {
		"description": "Identifiers of the NS instances for which performance information is collected.\n",
		"description": "Identifiers of the measured object instances for which performance information is collected. \n",
		"type": "array",
		"items": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		}
		},
		"subObjectInstanceIds": {
		"description": "Identifiers of the sub-object instances of the measured object instance for which performance information is requested to be collected. May be present if a sub-object is defined in clause 6.2 of ETSI GS NFV-IFA 027 for the related measured object type. If this attribute is present, the cardinality of the \"objectInstanceIds\" attribute shall be 1. If this attribute is absent and a sub-object is defined in clause 6.2 of ETSI GS NFV IFA 027 for the related measured object type, measurements will be taken for all sub-object instances of the measured object instance.\n",
		"type": "array",
		"items": {
		"description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n",
		"type": "string"
		}
		},
		"criteria": {
		"description": "This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1.\n",
		"description": "This type represents collection criteria for PM jobs. It shall comply with the provisions defined in Table 7.5.3.3-1.\nNOTE 1:\tAt the end of each reportingPeriod, the API producer 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.\nNOTE 2:\tIn 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. reporting period are reported together.\n",
		"type": "object",
		"required": [
		"collectionPeriod",
		@@ -28,40 +43,45 @@
		],
		"properties": {
		"performanceMetric": {
		"description": "This defines the types of performance metrics for the specified object instances. 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 object instances. Valid values are specified as \"Measurement Name\" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present.\n",
		"type": "array",
		"items": {
		"description": "This type represents stack of string values\n",
		"description": "A string as defined in IETF RFC 8259.\n",
		"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. 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 API producer that it can decompose to individual metrics. Valid values are specified as \"Measurement Group\" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present.\n",
		"type": "array",
		"items": {
		"description": "This type represents stack of string values\n",
		"description": "A string as defined in IETF RFC 8259.\n",
		"type": "string"
		}
		},
		"collectionPeriod": {
		"description": "Specifies the periodicity at which the producer will collect performance information. The unit shall be seconds. At the end of each reportingPeriod, the producer will inform the 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. In 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 API producer will collect performance information. The unit shall be seconds. See note 1 and note 2.\n",
		"type": "integer",
		"minimum": 0,
		"default": 0
		},
		"reportingPeriod": {
		"description": "Specifies the periodicity at which the producer will report to the consumer. about performance information. The unit shall be seconds. At the end of each reportingPeriod, the producer will inform the 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. In 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 API producer will report to the API consumer. about performance information. The unit shall be seconds. See note 1 and note 2.\n",
		"type": "integer",
		"minimum": 0,
		"default": 0
		},
		"reportingBoundary": {
		"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
		"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
		"type": "string",
		"format": "date-time"
		}
		}
		},
		"callbackUri": {
		"description": "String formatted according to IETF RFC 3986.\n",
		"type": "string",
		"format": "uri"
		},
		"reports": {
		"description": "Information about available reports collected by this PM job.\n",
		"type": "object",
		@@ -73,21 +93,72 @@
		"properties": {
		"href": {
		"description": "String formatted according to IETF RFC 3986.\n",
		"type": "string"
		"type": "string",
		"format": "uri"
		},
		"readyTime": {
		"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
		"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
		"type": "string",
		"format": "date-time"
		},
		"expiryTime": {
		"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
		"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
		"type": "string",
		"format": "date-time"
		},
		"fileSize": {
		"description": "The size of the report file in bytes, if known.\n",
		"type": "integer"
		"type": "integer",
		"minimum": 0
		}
		}
		},
		"pmJobConnection": {
		"description": "An access information and interface information of PM job to monitor the PM of VNF instance by the VNFM. This can include for instance certain interface endpoint URI together with necessary credentials to access it.\n",
		"type": "array",
		"items": {
		"description": "This type represents a MonitoringConnection.\nNOTE: The VNFM can be made aware of monitoring connection information, including their identifiers to be used by configuration means outside the scope of the present document (e.g. using relevant NFV-MANO management APIs as defined in ETSI GS NFV-SOL 009). \n",
		"type": "object",
		"required": [
		"id",
		"monitoringType"
		],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"monitoringType": {
		"description": "Type of monitoring way. VALUES: • VIM_CISM • EXTERNAL • PAAS\n",
		"type": "string",
		"enum": [
		"VIM_CISM",
		"EXTERNAL",
		"PAAS"
		]
		},
		"vimId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"paasServiceId": {
		"description": "An identifier with the intention of being globally unique.\n",
		"type": "string"
		},
		"interfaceInfo": {
		"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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
		"type": "object"
		},
		"accessInfo": {
		"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 key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
		"type": "object"
		},
		"extra": {
		"description": "Type specific additional information, if applicable.\n",
		"type": "string"
		}
		}
		}
		},
		"_links": {
		"description": "Links for this resource.\n",
		@@ -104,14 +175,14 @@
		],
		"properties": {
		"href": {
		"description": "URI of the referenced resource.\n",
		"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
		"type": "string",
		"format": "url"
		}
		}
		},
		"objects": {
		"description": "Links to resources representing the NS instances for which performance information is collected. Shall be present if the NS instance information is accessible as a resource.\n",
		"description": "Links to resources representing the measure object instances for which performance information is collected. Shall be present if the measured object instance information is accessible as a resource.\n",
		"type": "array",
		"items": {
		"description": "This type represents a link to a resource.\n",
		@@ -121,7 +192,7 @@
		],
		"properties": {
		"href": {
		"description": "URI of the referenced resource.\n",
		"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
		"type": "string",
		"format": "url"
		}
		@@ -132,5 +203,3 @@
		}
		}
		}
		No newline at end of file
		}
		}
		No newline at end of file

SOL005/NSPerformanceManagement-API/schemas/PmJobs.schema.json

+185 −116

File changed.

Preview size limit exceeded, changes collapsed.