ETSI GS NFV-SOL 013 V5.2.1 (2024-12)

Network Functions Virtualisation (NFV) Release 5; Protocols and Data Models; Specification of common aspects for RESTful NFV MANO APIs

RGS/NFV-SOL013ed521

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Citation in the OJ (auto-insert)
• Due Date: 10-Jan-2025
• Completion Date: 12-Dec-2024

Standards Content (Sample)

GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 5;
Protocols and Data Models;
Specification of common aspects for RESTful NFV MANO APIs
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.

2 ETSI GS NFV-SOL 013 V5.2.1 (2024-12)

Reference
RGS/NFV-SOL013ed521
Keywords
API, NFV, protocol
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from the
ETSI Search & Browse Standards application.
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format on ETSI deliver repository.
Users should be aware that the present document may be revised or have its status changed,
this information is available in the Milestones listing.
If you find errors in the present document, please send your comments to
the relevant service listed under Committee Support Staff.
If you find a security vulnerability in the present document, please report it through our
Coordinated Vulnerability Disclosure (CVD) program.
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2024.
All rights reserved.
ETSI
3 ETSI GS NFV-SOL 013 V5.2.1 (2024-12)
Contents
Intellectual Property Rights . 5
Foreword . 5
Modal verbs terminology . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 7
3 Definition of terms, symbols and abbreviations . 7
3.1 Terms . 7
3.2 Symbols . 7
3.3 Abbreviations . 7
4 HTTP usage . 8
4.1 URI structure and supported content formats . 8
4.2 Usage of HTTP header fields . 9
4.2.1 Introduction. 9
4.2.2 Request header fields . 9
4.2.3 Response header fields . 10
5 Result set control . 11
5.1 Introduction . 11
5.2 Attribute-based filtering . 11
5.2.1 Overview and example (informative) . 11
5.2.2 Specification . 12
5.3 Attribute selectors. 14
5.3.1 Overview and example (informative) . 14
5.3.2 Specification . 14
5.3.2.1 GET request . 14
5.3.2.2 GET response . 15
5.4 Handling of large query results . 15
5.4.1 Overview . 15
5.4.2 Specification . 16
5.4.2.1 Alternatives . 16
5.4.2.2 Error response . 16
5.4.2.3 Paged response . 16
6 Error reporting . 17
6.1 Introduction . 17
6.2 General mechanism . 17
6.3 Type: ProblemDetails . 17
6.4 Common error situations . 17
7 Common data types . 20
7.1 Structured data types . 20
7.1.1 Introduction. 20
7.1.2 Type: Object . 20
7.1.3 Type: Link . 20
7.1.4 Type: NotificationLink . 20
7.1.5 Type: KeyValuePairs . 20
7.1.6 Type: ApiVersionInformation . 20
7.1.7 Type: Checksum . 21
7.2 Simple data types and enumerations . 21
7.2.1 Introduction. 21
7.2.2 Simple data types . 21
7.2.3 Enumerations . 22
8 Authorization of API requests and notifications . 22
ETSI
4 ETSI GS NFV-SOL 013 V5.2.1 (2024-12)
8.1 Introduction . 22
8.2 Flows (informative) . 23
8.2.1 General . 23
8.2.2 Authorization of API requests using OAuth 2.0 access tokens . 23
8.2.3 Authorization of API requests using TLS certificates . 25
8.2.4 Authorization of notifications using the HTTP Basic authentication scheme . 25
8.2.5 Authorization of notifications using OAuth 2.0 access tokens . 25
8.2.6 Authorization of notifications using TLS certificates . 28
8.2.7 Authorization of API requests using OAuth 2.0 certificate-bound access tokens. 28
8.3 Specification . 30
8.3.1 Introduction. 30
8.3.2 General mechanism. 30
8.3.3 Authorizing API requests . 31
8.3.4 Authorizing the sending of notifications . 31
8.3.5 Client roles . 33
8.3.6 Support of authorization . 34
8.3.6.1 Authorization of API requests .
...