|
GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 2;
Protocols and Data Models;
RESTful protocols specification for
the Os-Ma-nfvo Reference Point
Disclaimer
The present document has been produced and approved by the Network Functions Virtualisation (NFV) ETSI Industry
Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.
---------------------- Page: 1 ----------------------
2 ETSI GS NFV-SOL 005 V2.5.1 (2018-09)
Reference
RGS/NFV-SOL005ed251
Keywords
API, NFV, protocol
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS NFV-SOL 005 V2.5.1 (2018-09)
Contents
Intellectual Property Rights . 17
Foreword . 17
Modal verbs terminology . 17
1 Scope . 18
2 References . 18
2.1 Normative references . 18
2.2 Informative references . 20
3 Abbreviations . 20
4 General Aspects . 22
4.1 Overview . 22
4.2 URI structure and supported content formats . 22
4.3 Common procedures. 23
4.3.1 Introduction. 23
4.3.2 Attribute-based filtering . 23
4.3.2.1 Overview and example (informative). 23
4.3.2.2 Specification. 24
4.3.3 Attribute selectors . 25
4.3.3.1 Overview and example . 25
4.3.3.2 Specification. 26
4.3.3.2.1 GET request . 26
4.3.3.2.2 GET response . 26
4.3.4 Usage of HTTP header fields . 27
4.3.4.1 Introduction . 27
4.3.4.2 Request header fields . 27
4.3.4.3 Response header fields . 28
4.3.5 Error reporting . 29
4.3.5.1 Introduction . 29
4.3.5.2 General mechanism . 29
4.3.5.3 Type: ProblemDetails. 29
4.3.5.4 Common error situations . 29
4.3.5.5 Overview of HTTP error status codes . 31
4.4 Common data types . 32
4.4.1 Structured data types . 32
4.4.1.1 Introduction . 32
4.4.1.2 Type: Object . 32
4.4.1.3 Type: Link . 32
4.4.1.3a Type: NotificationLink . 33
4.4.1.4 Type: KeyValuePairs . 33
4.4.1.5 Type: NsInstanceSubscriptionFilter . 33
4.4.1.6 Type: ResourceHandle . 34
4.4.1.7 Type: ApiVersionInformation . 34
4.4.2 Simple data types . 35
4.5 Authorization of API requests and notifications . 36
4.5.1 Introduction. 36
4.5.2 Flows (informative) . 36
4.5.2.0 General . 36
4.5.2.1 Authorization of API requests using OAuth 2.0 access tokens . 36
4.5.2.1a Authorization of API requests using TLS certificates . 38
4.5.2.2 Authorization of notifications using the HTTP Basic authentication scheme . 39
4.5.2.3 Authorization of notifications using OAuth 2.0 access tokens. 40
4.5.2.4 Authorization of notifications using TLS certificates . 42
4.5.3 Specification . 44
4.5.3.1 Introduction . 44
4.5.3.2 General mechanism . 44
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 005 V2.5.1 (2018-09)
4.5.3.3 Authorizing API requests . 44
4.5.3.4 Authorizing the sending of notifications . 45
4.5.3.5 Client roles . 46
4.5.3.6 Negotiation of authorization method . 47
4.5.3.6.1 Authorization of API requests . 47
4.5.3.6.2 Authorization of notification requests . 49
4.6 Version management . 50
4.6.1 Version identifiers and parameters . 50
4.6.1.1 Version identifiers . 50
4.6.1.2 Version parameters. 50
4.6.2 Rules for incrementing version identifier fields. 50
4.6.2.1 General . 50
4.6.2.2 Examples of backward and non-backward compatible changes . 51
4.6.3 Version information retrieval . 52
4.6.3.1 General . 52
4.6.3.2 Resource structure and methods . 52
4.6.3.3 Resource: API versions . 53
4.6.3.3.1 Description . 53
4.6.3.3.2 Resource definition . 53
4.6.3.3.3 Resource methods . 53
4.6.4 Version signalling . 54
4.7 Handling of large query results . 55
4.7.1 Description . 55
4.7.2 Specification . 55
4.7.2.1 Alternatives . 55
4.7.2.2 Error response . 55
4.7.2.3 Paged response . 55
5 NSD Management interface . 56
5.1 Description . 56
5.1a API version . 57
5.2 Resource structure and methods . 57
5.3 Sequence diagrams (informative) . 58
5.3.1 Flow of the creation of an individual NS descriptor resource . 58
5.3.2 Flow of the uploading of NSD content . 59
5.3.3 Flow of the fetching of NSD content . 59
5.3.4 Flow of the update of an individual NS descriptor resource . 60
5.3.5 Flow of the deletion of an individual NS descriptor resource . 61
5.3.6 Flow of the querying/reading of NS descriptor resources . 62
5.3.7 Flow of the creation of an individual PNF descriptor resource . 63
5.3.8 Flow of the uploading of PNFD content . 64
5.3.9 Flow of the fetching of PNFD content . 65
5.3.10 Flow of the deletion of an individual PNF descriptor resource . 65
5.3.11 Flow of the querying/reading of PNF descriptor resources . 66
5.3.12 Flow of managing subscriptions . 67
5.3.13 Flow of sending notifications. 69
5.4 Resources . 70
5.4.1 Introduction. 70
5.4.2 Resource: NS Descriptors . 70
5.4.2.1 Description . 70
5.4.2.2 Resource definition . 70
5.4.2.3 Resource methods . 71
5.4.2.3.1 POST . 71
5.4.2.3.2 GET . 71
5.4.2.3.3 PUT . 72
5.4.2.3.4 PATCH . 72
5.4.2.3.5 DELETE . 72
5.4.3 Resource: Individual NS Descriptor . 73
5.4.3.1 Description . 73
5.4.3.2 Resource definition . 73
5.4.3.3 Resource methods . 73
5.4.3.3.1 POST . 73
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 005 V2.5.1 (2018-09)
5.4.3.3.2 GET . 73
5.4.3.3.3 PUT . 74
5.4.3.3.4 PATCH . 74
5.4.3.3.5 DELETE . 75
5.4.4 Resource: NSD Content . 76
5.4.4.1 Description . 76
5.4.4.2 Resource definition . 76
5.4.4.3 Resource methods . 76
5.4.4.3.1 POST . 76
5.4.4.3.2 GET . 77
5.4.4.3.3 PUT . 78
5.4.4.3.4 PATCH . 79
5.4.4.3.5 DELETE . 79
5.4.5 Resource: PNF Descriptors . 80
5.4.5.1 Description . 80
5.4.5.2 Resource definition . 80
5.4.5.3 Resource methods . 80
5.4.5.3.1 POST . 80
5.4.5.3.2 GET . 81
5.4.5.3.3 PUT . 82
5.4.5.3.4 PATCH . 82
5.4.5.3.5 DELETE . 82
5.4.6 Resource: Individual PNF Descriptor . 82
5.4.6.1 Description . 82
5.4.6.2 Resource definition . 83
5.4.6.3 Resource methods . 83
5.4.6.3.1 POST . 83
5.4.6.3.2 GET . 83
5.4.6.3.3 PUT . 83
5.4.6.3.4 PATCH . 84
5.4.6.3.5 DELETE . 84
5.4.7 Resource: PNFD Content . 85
5.4.7.1 Description . 85
5.4.7.2 Resource definition . 85
5.4.7.3 Resource methods . 85
5.4.7.3.1 POST . 85
5.4.7.3.2 GET . 85
5.4.7.3.3 PUT . 86
5.4.7.3.4 PATCH . 87
5.4.7.3.5 DELETE . 87
5.4.8 Resource: Subscriptions . 87
5.4.8.1 Description . 87
5.4.8.2 Resource definition . 87
5.4.8.3 Resource methods . 88
5.4.8.3.1 POST . 88
5.4.8.3.2 GET . 88
5.4.8.3.3 PUT . 89
5.4.8.3.4 PATCH . 89
5.4.8.3.5 DELETE . 89
5.4.9 Resource: Individual subscription . 90
5.4.9.1 Description . 90
5.4.9.2 Resource definition . 90
5.4.9.3 Resource methods . 90
5.4.9.3.1 POST . 90
5.4.9.3.2 GET .
...