1、 ETSI GS NFV-SOL 002 V2.4.1 (2018-02) Network Functions Virtualisation (NFV) Release 2; Protocols and Data Models; RESTful protocols specification for the Ve-Vnfm Reference Point Disclaimer The present document has been produced and approved by the Network Functions Virtualisation (NFV) ETSI Industr
2、y 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. GROUP SPECIFICATION ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)2 Reference RGS/NFV-SOL002ed241 Keywords API, NFV, protocol ETSI
3、 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 enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice The present document can be downloaded from: http:/
4、www.etsi.org/standards-search 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 dif
5、ference 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 c
6、hange of status. Information on the current status of this and other ETSI documents is available at https:/portal.etsi.org/TB/ETSIDeliverableStatus.aspx If you find errors in the present document, please send your comment to one of the following services: https:/portal.etsi.org/People/CommiteeSuppor
7、tStaff.aspx 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 authorizat
8、ion of ETSI. The copyright and the foregoing restriction extend to reproduction in all media. ETSI 2018. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTMand the ETSI logo are trademarks of ETSI registered for the benefit of its Members. 3GPPTM and LTETMare trademarks of ETSI registered for the benef
9、it of its Members and of the 3GPP Organizational Partners. oneM2M logo is protected for the benefit of its Members. GSMand the GSM logo are trademarks registered and owned by the GSM Association. ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)3 Contents Intellectual Property Rights 14g3Foreword . 14g3Moda
10、l verbs terminology 14g31 Scope 15g32 References 15g32.1 Normative references . 15g32.2 Informative references 16g33 Definitions and abbreviations . 17g33.1 Definitions 17g33.2 Abbreviations . 17g34 General aspects . 18g34.1 Overview 18g34.2 URI structure and supported content formats . 18g34.3 Comm
11、on procedures. 19g34.3.1 Introduction. 19g34.3.2 Attribute-based filtering 19g34.3.2.1 Overview and example (informative) 19g34.3.2.2 Specification 20g34.3.3 Attribute selectors . 21g34.3.3.1 Overview and example (informative) 21g34.3.3.2 Specification 21g34.3.3.2.1 GET request . 21g34.3.3.2.2 GET r
12、esponse 22g34.3.4 Usage of HTTP header fields 22g34.3.4.1 Introduction . 22g34.3.4.2 Request header fields 22g34.3.4.3 Response header fields 23g34.3.5 Error reporting 23g34.3.5.1 Introduction . 23g34.3.5.2 General mechanism . 23g34.3.5.3 Type: ProblemDetails 24g34.3.5.4 Common error situations . 24
13、g34.3.5.5 Overview of HTTP error status codes . 25g34.4 Common data types 26g34.4.1 Structured data types . 26g34.4.1.1 Introduction . 26g34.4.1.2 Type: Object 26g34.4.1.3 Type: Link . 26g34.4.1.4 Type: KeyValuePairs 26g34.4.1.5 Type: VnfInstanceSubscriptionFilter 27g34.4.2 Simple data types and enu
14、merations . 27g34.4.2.1 Introduction . 27g34.4.2.2 Simple data types 27g34.4.2.3 Enumerations 28g34.5 Authorization of API requests and notifications 28g34.5.1 Introduction. 28g34.5.2 Flows (informative) 29g34.5.2.0 General 29g34.5.2.1 Authorization of API requests using OAuth 2.0 access tokens . 29
15、g34.5.2.1a Authorization of API requests using TLS certificates . 31g34.5.2.2 Authorization of notifications using the HTTP Basic authentication scheme . 32g34.5.2.3 Authorization of notifications using OAuth 2.0 access tokens 33g34.5.2.4 Authorization of notifications using TLS certificates . 35g34
16、.5.3 Specification . 37g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)4 4.5.3.1 Introduction . 37g34.5.3.2 General mechanism . 37g34.5.3.3 Authorizing API requests 37g34.5.3.4 Authorizing the sending of notifications . 38g34.5.3.5 Client roles 39g34.5.3.6 Negotiation of authorization method . 40g34.5.3.
17、6.1 Authorization of API requests . 40g34.5.3.6.2 Authorization of notification requests . 41g35 VNF Lifecycle Management interface . 41g35.1 Description . 41g35.2 Resource structure and methods . 42g35.3 Sequence diagrams (informative) . 44g35.3.1 Flow of the creation of a VNF instance resource 44g
18、35.3.2 Flow of the deletion of a VNF instance resource 45g35.3.3 Flow of VNF lifecycle management operations triggered by task resources 46g35.3.4 Flow of automatic invocation of VNF scaling and VNF healing 49g35.3.5 Flow of the Query VNF operation 51g35.3.6 Flow of the Modify VNF Information operat
19、ion 52g35.3.7 Flow of the Get Operation Status operation 53g35.3.8 Flow of managing subscriptions . 54g35.3.9 Flow of sending notifications 56g35.3.10 Flow of retrying a VNF lifecycle management operation . 57g35.3.11 Flow of rolling back a VNF lifecycle management operation 58g35.3.12 Flow of faili
20、ng a VNF lifecycle management operation . 59g35.3.13 Flow of cancelling a VNF lifecycle management operation . 60g35.4 Resources . 62g35.4.1 Introduction. 62g35.4.2 Resource: VNF instances 62g35.4.2.1 Description 62g35.4.2.2 Resource definition . 63g35.4.2.3 Resource methods . 63g35.4.2.3.1 POST . 6
21、3g35.4.2.3.2 GET . 63g35.4.2.3.3 PUT . 64g35.4.2.3.4 PATCH 64g35.4.2.3.5 DELETE 65g35.4.3 Resource: Individual VNF instance 65g35.4.3.1 Description 65g35.4.3.2 Resource definition . 65g35.4.3.3 Resource methods . 65g35.4.3.3.1 POST . 65g35.4.3.3.2 GET . 65g35.4.3.3.3 PUT . 66g35.4.3.3.4 PATCH 66g35.
22、4.3.3.5 DELETE 67g35.4.4 Resource: Instantiate VNF task 68g35.4.4.1 Description 68g35.4.4.2 Resource definition . 68g35.4.4.3 Resource methods . 68g35.4.4.3.1 POST . 68g35.4.4.3.2 GET . 69g35.4.4.3.3 PUT . 69g35.4.4.3.4 PATCH 69g35.4.4.3.5 DELETE 69g35.4.5 Resource: Scale VNF task 69g35.4.5.1 Descri
23、ption 69g35.4.5.2 Resource definition . 69g35.4.5.3 Resource methods . 70g35.4.5.3.1 POST . 70g35.4.5.3.2 GET . 71g35.4.5.3.3 PUT . 71g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)5 5.4.5.3.4 PATCH 71g35.4.5.3.5 DELETE 71g35.4.6 Resource: Scale VNF to Level task 72g35.4.6.1 Description 72g35.4.6.2 Reso
24、urce definition . 72g35.4.6.3 Resource methods . 72g35.4.6.3.1 POST . 72g35.4.6.3.2 GET . 73g35.4.6.3.3 PUT . 73g35.4.6.3.4 PATCH 73g35.4.6.3.5 DELETE 73g35.4.7 Resource: Change VNF Flavour task . 74g35.4.7.1 Description 74g35.4.7.2 Resource definition . 74g35.4.7.3 Resource methods . 74g35.4.7.3.1
25、POST . 74g35.4.7.3.2 GET . 75g35.4.7.3.3 PUT . 75g35.4.7.3.4 PATCH 75g35.4.7.3.5 DELETE 75g35.4.8 Resource: Terminate VNF task . 76g35.4.8.1 Description 76g35.4.8.2 Resource definition . 76g35.4.8.3 Resource methods . 76g35.4.8.3.1 POST . 76g35.4.8.3.2 GET . 77g35.4.8.3.3 PUT . 77g35.4.8.3.4 PATCH 7
26、7g35.4.8.3.5 DELETE 77g35.4.9 Resource: Heal VNF task . 77g35.4.9.1 Description 77g35.4.9.2 Resource definition . 77g35.4.9.3 Resource methods . 78g35.4.9.3.1 POST . 78g35.4.9.3.2 GET . 79g35.4.9.3.3 PUT . 79g35.4.9.3.4 PATCH 79g35.4.9.3.5 DELETE 79g35.4.10 Resource: Operate VNF task 80g35.4.10.1 De
27、scription 80g35.4.10.2 Resource definition . 80g35.4.10.3 Resource methods . 80g35.4.10.3.1 POST . 80g35.4.10.3.2 GET . 81g35.4.10.3.3 PUT . 81g35.4.10.3.4 PATCH 81g35.4.10.3.5 DELETE 81g35.4.11 Resource: Change external VNF connectivity task 82g35.4.11.1 Description 82g35.4.11.2 Resource definition
28、 . 82g35.4.11.3 Resource methods . 82g35.4.11.3.1 POST . 82g35.4.11.3.2 GET . 83g35.4.11.3.3 PUT . 83g35.4.11.3.4 PATCH 83g35.4.11.3.5 DELETE 83g35.4.12 Resource: VNF LCM operation occurrences 83g35.4.12.1 Description 83g35.4.12.2 Resource definition . 83g35.4.12.3 Resource methods . 84g35.4.12.3.1
29、POST . 84g35.4.12.3.2 GET . 84g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)6 5.4.12.3.3 PUT . 85g35.4.12.3.4 PATCH 85g35.4.12.3.5 DELETE 85g35.4.13 Resource: Individual VNF LCM operation occurrence 85g35.4.13.1 Description 85g35.4.13.2 Resource definition . 85g35.4.13.3 Resource methods . 86g35.4.13.3
30、.1 POST . 86g35.4.13.3.2 GET . 86g35.4.13.3.3 PUT . 86g35.4.13.3.4 PATCH 86g35.4.13.3.5 DELETE 87g35.4.14 Resource: Retry operation task . 87g35.4.14.1 Description 87g35.4.14.2 Resource definition . 87g35.4.14.3 Resource methods . 87g35.4.14.3.1 POST . 87g35.4.14.3.2 GET . 88g35.4.14.3.3 PUT . 88g35
31、.4.14.3.4 PATCH 88g35.4.14.3.5 DELETE 88g35.4.15 Resource: Rollback operation task 89g35.4.15.1 Description 89g35.4.15.2 Resource definition . 89g35.4.15.3 Resource methods . 89g35.4.15.3.1 POST . 89g35.4.15.3.2 GET . 90g35.4.15.3.3 PUT . 90g35.4.15.3.4 PATCH 90g35.4.15.3.5 DELETE 90g35.4.16 Resourc
32、e: Fail operation task 91g35.4.16.1 Description 91g35.4.16.2 Resource definition . 91g35.4.16.3 Resource methods . 91g35.4.16.3.1 POST . 91g35.4.16.3.2 GET . 92g35.4.16.3.3 PUT . 92g35.4.16.3.4 PATCH 92g35.4.16.3.5 DELETE 92g35.4.17 Resource: Cancel operation task . 93g35.4.17.1 Description 93g35.4.
33、17.2 Resource definition . 93g35.4.17.3 Resource methods . 93g35.4.17.3.1 POST . 93g35.4.17.3.2 GET . 94g35.4.17.3.3 PUT . 94g35.4.17.3.4 PATCH 94g35.4.17.3.5 DELETE 94g35.4.18 Resource: Subscriptions 95g35.4.18.1 Description 95g35.4.18.2 Resource definition . 95g35.4.18.3 Resource methods . 95g35.4
34、.18.3.1 POST . 95g35.4.18.3.2 GET . 96g35.4.18.3.3 PUT . 97g35.4.18.3.4 PATCH 97g35.4.18.3.5 DELETE 97g35.4.19 Resource: Individual subscription . 97g35.4.19.1 Description 97g35.4.19.2 Resource definition . 97g35.4.19.3 Resource methods . 98g35.4.19.3.1 POST . 98g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (20
35、18-02)7 5.4.19.3.2 GET . 98g35.4.19.3.3 PUT . 98g35.4.19.3.4 PATCH 98g35.4.19.3.5 DELETE 98g35.4.20 Resource: Notification endpoint . 99g35.4.20.1 Description 99g35.4.20.2 Resource definition . 99g35.4.20.3 Resource methods . 99g35.4.20.3.1 POST . 99g35.4.20.3.2 GET . 100g35.4.20.3.3 PUT . 100g35.4.
36、20.3.4 PATCH 100g35.4.20.3.5 DELETE 101g35.5 Data model . 101g35.5.1 Introduction. 101g35.5.2 Resource and notification data types 101g35.5.2.1 Introduction . 101g35.5.2.2 Type: VnfInstance . 101g35.5.2.3 Type: CreateVnfRequest . 103g35.5.2.4 Type: InstantiateVnfRequest . 104g35.5.2.5 Type: ScaleVnf
37、Request . 104g35.5.2.6 Type: ScaleVnfToLevelRequest . 105g35.5.2.7 Type: ChangeVnfFlavourRequest. 105g35.5.2.8 Type: TerminateVnfRequest . 105g35.5.2.9 Type: HealVnfRequest 106g35.5.2.10 Type: OperateVnfRequest. 106g35.5.2.11 Type: ChangeExtVnfConnectivityRequest . 107g35.5.2.12 Type: VnfInfoModific
38、ationRequest 107g35.5.2.12a Type: VnfInfoModifications . 108g35.5.2.13 Type: VnfLcmOpOcc 109g35.5.2.14 Type: CancelMode 111g35.5.2.15 Type: LccnSubscriptionRequest . 111g35.5.2.16 Type: LccnSubscription 111g35.5.2.17 Type: VnfLcmOperationOccurrenceNotification . 111g35.5.2.18 Type: VnfIdentifierCrea
39、tionNotification 113g35.5.2.19 Type: VnfIdentifierDeletionNotification 113g35.5.3 Referenced structured data types 114g35.5.3.1 Introduction . 114g35.5.3.2 Type: ExtVirtualLinkData 114g35.5.3.3 Type: ExtVirtualLinkInfo . 114g35.5.3.4 Type: ExtManagedVirtualLinkData 115g35.5.3.5 Type: ExtManagedVirtu
40、alLinkInfo. 115g35.5.3.6 Type: VnfExtCpData 115g35.5.3.6a Type: VnfExtCpConfig . 116g35.5.3.6b Type: CpProtocolData . 116g35.5.3.6c Type: IpOverEthernetAddressData . 117g35.5.3.7 Type: ScaleInfo . 117g35.5.3.8 Type: VnfcResourceInfo . 118g35.5.3.9 Type: VnfVirtualLinkResourceInfo 118g35.5.3.10 Type:
41、 VirtualStorageResourceInfo . 118g35.5.3.11 Type: VnfLinkPortInfo . 119g35.5.3.12 Type: ExtLinkPortInfo 119g35.5.3.12a Type: ExtLinkPortData . 119g35.5.3.13 Type: ResourceHandle 120g35.5.3.14 VOID . 120g35.5.3.15 VOID . 120g35.5.3.15a Type: CpProtocolInfo 120g35.5.3.16 Type: IpOverEthernetAddressInf
42、o 121g35.5.3.17 Type: MonitoringParameter 121g35.5.3.18 Type: LifecycleChangeNotificationsFilter 121g35.5.3.19 Type: AffectedVnfc 122g35.5.3.20 Type: AffectedVirtualLink 123g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)8 5.5.3.21 Type: AffectedVirtualStorage . 124g35.5.3.22 Type: LccnLinks . 124g35.5.3
43、.23 Type: VnfcInfo 125g35.5.3.24 Type: VnfcInfoModifications . 125g35.5.4 Referenced simple data types and enumerations 125g35.5.4.1 Introduction . 125g35.5.4.2 Simple data types 125g35.5.4.3 Enumeration: VnfOperationalStateType . 126g35.5.4.4 Void. 126g35.5.4.5 Enumeration: LcmOperationType . 126g3
44、5.5.4.6 Enumeration: LcmOperationStateType . 126g35.5.4.7 Enumeration: CancelModeType . 126g35.6 Handling of errors during VNF lifecycle management operations . 127g35.6.1 Basic concepts (informative) 127g35.6.1.1 Motivation . 127g35.6.1.2 Failure resolution strategies: Retry and Rollback . 127g35.6
45、.1.3 Error handling at VNFM and EM . 128g35.6.2 States and state transitions of a VNF lifecycle management operation occurrence 129g35.6.2.1 General 129g35.6.2.2 States of a VNF lifecycle management operation occurrence . 129g35.6.2.3 Error handling operations that change the state of a VNF lifecycl
46、e management operation occurrence . 132g35.6.3 Detailed flows . 133g35.6.3.1 Immediate failure 133g35.6.3.2 Failure in “STARTING“ state . 133g35.6.3.3 Failure during actual LCM operation execution . 134g35.6.3.4 LCM operation cancellation 136g36 VNF Performance Management interface 136g36.1 Descript
47、ion . 136g36.2 Resource structure and methods . 136g36.3 Sequence diagrams (informative) . 137g36.3.1 Flow of creating a PM job 137g36.3.2 Flow of querying/reading PM jobs . 138g36.3.3 Flow of deleting a PM job 139g36.3.4 Flow of obtaining performance reports . 139g36.3.5 Flow of creating a threshol
48、d . 140g36.3.6 Flow of querying/reading thresholds 141g36.3.7 Flow of deleting thresholds . 141g36.3.8 Flow of managing subscriptions . 142g36.3.9 Flow of sending notifications 144g36.4 Resources . 145g36.4.1 Introduction. 145g36.4.2 Resource: PM jobs 145g36.4.2.1 Description 145g36.4.2.2 Resource d
49、efinition . 145g36.4.2.3 Resource methods . 145g36.4.2.3.1 POST . 145g36.4.2.3.2 GET . 146g36.4.2.3.3 PUT . 146g36.4.2.3.4 PATCH 147g36.4.2.3.5 DELETE 147g36.4.3 Resource: Individual PM job 147g36.4.3.1 Description 147g36.4.3.2 Resource definition . 147g36.4.3.3 Resource methods . 147g36.4.3.3.1 POST . 147g36.4.3.3.2 GET . 147g36.4.3.3.3 PUT . 148g36.4.3.3.4 PATCH 148g36.4.3.3.5 DELETE 148g36.4.4 Resource: Individual performance report . 149g3ETSI ETSI GS NFV-SOL 002 V2.4.1 (2018-02)9 6.4.4.1 Description 149g36.4.4.2 Resource definition . 149g36.4.4.3 Resource methods . 149g36.4
