Merge branch 'NFVSOL(26)000035_SOL026_Clause_10_API_resources_and_data_model' into 'main' (73ce9386) · Commits · NFV - Network Functions Virtualisation / Specifications / GS NFV-SOL 026

GS_NFV-SOL_026.md

+81 −2

Original line number	Diff line number	Diff line
		@@ -1780,10 +1780,89 @@ The HTTP methods marked as \"M\" (mandatory) in the \"Cat\" column of table 10.3
		The physical resource fault management service interface supports notifying the subscribed consumers about any faults or alarms that may occur related to the concerned physical resources. Flows related to subscription management and notifications described in Annex A of the present document are also applicable for the subscriptions and notifications related to fault management supported by this service interface.

		## 10.5 Resources
		<mark>Editor's Note: This sub-clause will add API resources of the service interface.</mark>

		### 10.5.1 Introduction

		The present clause specifies API resources (endpoints) of the physical resource fault management service interface.

		### 10.5.2 Resource: Subscriptions

		This resource represents subscriptions related to fault management of physical resources and can be used to retrieve a collection of already created subscription resources as well as to create a new individual subscription resource. This resource can be used to create a subscription for receiving notifications about faults associated with physical resources.

		Table 10.5.2-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

		The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

		Table 10.5.2-1: Subscriptions resource methods mapped against PIM service interface requirements

		+------------------+---------------+-------------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
		\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
		+:=================+:==============+:================================================+:================================+
		\|.../Subscriptions \|GET \|Lists a collection of subscriptions. \|PimPrFmMgt.003 \|
		\|(see note) \| \|Retrieves information about the \| \|
		\| \| \|created subscriptions related to \| \|
		\| \| \|to fault management of physical \| \|
		\| \| \|resources managed by the PIM. \| \|
		\| +---------------+-------------------------------------------------+---------------------------------+
		\| \|POST \|Creates a new Individual Subscription resource. \|PimPrFmMgt.003 \|
		+------------------+---------------+-------------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 10.3-1 for the full URI of this resource. \|
		+----------------------------------------------------------------------------------------------------------------------+

		### 10.5.3 Resource: Individual Subscription

		This resource represents an individual subscription related to fault management of physical resources managed by the PIM, and can be used to query, update or delete the individual subscription resource.

		Table 10.5.3-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

		The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

		Table 10.5.3-1: Individual Subscription resource methods mapped against PIM service interface requirements

		+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \|Requirement identifier from\ \|
		\| \| \| \|ETSI GS NFV-IFA 053 [ 1 ] \|
		+:============================================+:==============+:=============================================+:================================+
		\|.../Subscriptions/{SubscriptionId} (see note)\|GET \|Retrieves information about an individual \|PimPrFmMgt.003 \|
		\| \| \|subscription resource managed by the PIM. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|PUT \|Modifies the individual subscription \|PimPrFmMgt.003 \|
		\| \| \|resource by replacing it whole. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|PATCH \|Modifies the individual subscription \|PimPrFmMgt.003 \|
		\| \| \|resource by updating only a patch of it. \| \|
		\| +---------------+----------------------------------------------+---------------------------------+
		\| \|DELETE \|Deletes the individual subscription resource. \|PimPrFmMgt.003 \|
		+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 10.3-1 for the full URI of this resource. \|
		+---------------------------------------------+---------------+----------------------------------------------+---------------------------------+

		### 10.5.4 Resource: Individual Task Monitor

		This resource represents an individual task monitor for an asynchronous operation being performed by the PIM and can be used by the API consumer to monitor the progress of an asynchronous operation as well as receive the result of the requested operation once the corresponding task has been completed.

		Table 10.5.4-1 specifies the supported HTTP methods for this resource and maps them against the PIM service interface requirements as specified in ETSI GS NFV-IFA 053 [\[1\]](#_ref_1).

		The URI query parameters, request and response bodies, and response codes of the individual resource methods shall follow the provisions specified in Redfish® specification [\[2\]](#_ref_2).

		Table 10.5.4-1: Individual Task Monitor resource methods mapped against PIM service interface requirements

		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|Resource URI \|HTTP Method \|Meaning \| Requirement identifier from\ \|
		\| \| \| \| ETSI GS NFV-IFA 053 [ 1 ] \|
		+:============================================+:==============+:==================================================+:================================+
		\|.../TaskService/TaskMonitors/{TaskMonitorId} \|GET \|Retrieves result of an asynchronous operation \|PimPrFmMgt.003 \|
		\|(see note) \| \|related to physical resource log management \| \|
		\| \| \|once that operation has been completed. \| \|
		+---------------------------------------------+---------------+---------------------------------------------------+---------------------------------+
		\|NOTE: Refer to Table 10.3-1 for the full URI of this resource. \|
		+---------------------------------------------------------------------------------------------------------------------------------------------------+

		<mark>Editor's Note: Individual Task Monitor resource may not be needed for this service interface and therefore may be deleted later on. The reason for this is that creation/modification/deletion of subscription resources may not be very time-consuming operations and therefore not require asynchronous support.</mark>

		## 10.6 Data model
		<mark>Editor's Note: This sub-clause will add data model of the service interface.</mark>
		The request and response data structures of the physical resource fault management service interface are defined in the Redfish® data model specification [\[3\]](#_ref_3).

		# 11 Physical resource log management service interface

Admin message