ETSI GS NFV-SOL 003-2017 Network Functions Virtualisation (NFV) Protocols and Data Models RESTful protocols specification for the Or-Vnfm Reference Point (V2 3 1 Release 2).pdf

1、 ETSI GS NFV-SOL 003 V2.3.1 (2017-07) Network Functions Virtualisation (NFV) Release 2; Protocols and Data Models; RESTful protocols specification for the Or-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 003 V2.3.1 (2017-07)2 Reference DGS/NFV-SOL003 Keywords API, NFV, protocol ETSI 650

3、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:/www.e

4、tsi.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 differen

5、ce 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

6、 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/CommiteeSupportStaf

7、f.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 authorization o

8、f ETSI. The copyright and the foregoing restriction extend to reproduction in all media. ETSI 2017. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTMand the ETSI logo are trademarks of ETSI registered for the benefit of its Members. 3GPPTM and LTE are trademarks of ETSI registered for the benefit of

9、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 ETSI GS NFV-SOL 003 V2.3.1 (2017-07)3 Contents Intellectual Property Rights 17g3Foreword . 17g3Modal ver

10、bs terminology 17g31 Scope 18g32 References 18g32.1 Normative references . 18g32.2 Informative references 19g33 Definitions and abbreviations . 20g33.1 Definitions 20g33.2 Abbreviations . 20g34 General aspects . 21g34.1 Overview 21g34.2 URI structure and supported content formats . 21g34.3 Common pr

11、ocedures. 22g34.3.1 Introduction. 22g34.3.2 Attribute-based filtering 22g34.3.2.1 Overview and example (informative) 22g34.3.2.2 Specification 23g34.3.3 Attribute selectors . 24g34.3.3.1 Overview and example (informative) 24g34.3.3.2 Specification 24g34.3.3.2.1 GET request . 24g34.3.3.2.2 GET respon

12、se 25g34.3.4 Usage of HTTP header fields 26g34.3.4.1 Introduction . 26g34.3.4.2 Request header fields 26g34.3.4.3 Response header fields 27g34.3.5 Error reporting 27g34.3.5.1 Introduction . 27g34.3.5.2 General mechanism . 27g34.3.5.3 Type: ProblemDetails 28g34.3.5.4 Common error situations . 28g34.3

13、.5.5 Overview of HTTP error status codes . 29g34.4 Common data types 30g34.4.1 Structured data types . 30g34.4.1.1 Introduction . 30g34.4.1.2 Type: Object 30g34.4.1.3 Type: Link . 30g34.4.1.4 Type: KeyValuePairs 31g34.4.1.5 Type: VnfInstanceSubscriptionFilter 31g34.4.1.6 Type: VimConnectionInfo 32g3

14、4.4.1.7 Type: ResourceHandle 32g34.4.1.8 Type: FixedNetworkAddressData . 33g34.4.1.9 Type: DynamicNetworkAddressData . 34g34.4.1.10 Type: VnfExtCpData 34g34.4.1.11 Type: ExtVirtualLinkData 34g34.4.1.12 Type: ExtManagedVirtualLinkData 35g34.4.2 Simple data types and enumerations . 35g34.4.2.1 Introdu

15、ction . 35g34.4.2.2 Simple data types 36g34.4.2.3 Enumeration: LcmOperationType . 36g34.5 Authorization of API requests and notifications 36g34.5.1 Introduction. 36g34.5.2 Flows (informative) 37g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)4 4.5.2.1 Authorization of API requests . 37g34.5.2.2 Authoriza

16、tion of notifications using the HTTP Basic authentication scheme . 39g34.5.2.3 Authorization of notifications using OAuth 2.0 40g34.5.3 Specification . 42g34.5.3.1 Introduction . 42g34.5.3.2 General mechanism . 42g34.5.3.3 Authorizing API requests 42g34.5.3.4 Authorizing the sending of notifications

17、 . 43g34.5.3.5 Client roles 44g35 VNF Lifecycle Management interface . 44g35.1 Description . 44g35.2 Resource structure and methods . 45g35.3 Sequence diagrams (informative) . 47g35.3.1 Flow of the creation of a VNF instance resource 47g35.3.2 Flow of the deletion of a VNF instance resource 49g35.3.

18、3 Flow of VNF lifecycle management operations triggered by task resources 49g35.3.4 Flow of automatic invocation of VNF scaling and VNF healing 52g35.3.5 Flow of the Query VNF operation 54g35.3.6 Flow of the Modify VNF Information operation 55g35.3.7 Flow of the Get Operation Status operation 56g35.

19、3.8 Flow of managing subscriptions . 58g35.3.9 Flow of sending notifications 59g35.3.10 Flow of retrying a VNF lifecycle management operation . 60g35.3.11 Flow of rolling back a VNF lifecycle management operation 61g35.3.12 Flow of failing a VNF lifecycle management operation . 62g35.3.13 Flow of ca

20、ncelling a VNF lifecycle management operation . 63g35.4 Resources . 64g35.4.1 Introduction. 64g35.4.2 Resource: VNF instances 65g35.4.2.1 Description 65g35.4.2.2 Resource definition . 65g35.4.2.3 Resource methods . 65g35.4.2.3.1 POST . 65g35.4.2.3.2 GET . 66g35.4.2.3.3 PUT . 67g35.4.2.3.4 PATCH 67g3

21、5.4.2.3.5 DELETE 67g35.4.3 Resource: Individual VNF instance 67g35.4.3.1 Description 67g35.4.3.2 Resource definition . 67g35.4.3.3 Resource methods . 68g35.4.3.3.1 POST . 68g35.4.3.3.2 GET . 68g35.4.3.3.3 PUT . 68g35.4.3.3.4 PATCH 68g35.4.3.3.5 DELETE 69g35.4.4 Resource: Instantiate VNF task 70g35.4

22、.4.1 Description 70g35.4.4.2 Resource definition . 70g35.4.4.3 Resource methods . 70g35.4.4.3.1 POST . 70g35.4.4.3.2 GET . 71g35.4.4.3.3 PUT . 71g35.4.4.3.4 PATCH 71g35.4.4.3.5 DELETE 71g35.4.5 Resource: Scale VNF task 71g35.4.5.1 Description 71g35.4.5.2 Resource definition . 72g35.4.5.3 Resource me

23、thods . 72g35.4.5.3.1 POST . 72g35.4.5.3.2 GET . 73g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)5 5.4.5.3.3 PUT . 73g35.4.5.3.4 PATCH 73g35.4.5.3.5 DELETE 74g35.4.6 Resource: Scale VNF to Level task 74g35.4.6.1 Description 74g35.4.6.2 Resource definition . 74g35.4.6.3 Resource methods . 74g35.4.6.3.1

24、POST . 74g35.4.6.3.2 GET . 75g35.4.6.3.3 PUT . 75g35.4.6.3.4 PATCH 75g35.4.6.3.5 DELETE 76g35.4.7 Resource: Change VNF Flavour task . 76g35.4.7.1 Description 76g35.4.7.2 Resource definition . 76g35.4.7.3 Resource methods . 76g35.4.7.3.1 POST . 76g35.4.7.3.2 GET . 77g35.4.7.3.3 PUT . 77g35.4.7.3.4 PA

25、TCH 77g35.4.7.3.5 DELETE 78g35.4.8 Resource: Terminate VNF task . 78g35.4.8.1 Description 78g35.4.8.2 Resource definition . 78g35.4.8.3 Resource methods . 78g35.4.8.3.1 POST . 78g35.4.8.3.2 GET . 79g35.4.8.3.3 PUT . 79g35.4.8.3.4 PATCH 79g35.4.8.3.5 DELETE 79g35.4.9 Resource: Heal VNF task . 79g35.4

26、.9.1 Description 79g35.4.9.2 Resource definition . 80g35.4.9.3 Resource methods . 80g35.4.9.3.1 POST . 80g35.4.9.3.2 GET . 81g35.4.9.3.3 PUT . 81g35.4.9.3.4 PATCH 81g35.4.9.3.5 DELETE 82g35.4.10 Resource: Operate VNF task 82g35.4.10.1 Description 82g35.4.10.2 Resource definition . 82g35.4.10.3 Resou

27、rce methods . 82g35.4.10.3.1 POST . 82g35.4.10.3.2 GET . 83g35.4.10.3.3 PUT . 83g35.4.10.3.4 PATCH 84g35.4.10.3.5 DELETE 84g35.4.11 Resource: Change external VNF connectivity task 84g35.4.11.1 Description 84g35.4.11.2 Resource definition . 84g35.4.11.3 Resource methods . 84g35.4.11.3.1 POST . 84g35.

28、4.11.3.2 GET . 85g35.4.11.3.3 PUT . 85g35.4.11.3.4 PATCH 85g35.4.11.3.5 DELETE 85g35.4.12 Resource: VNF LCM operation occurrences 85g35.4.12.1 Description 85g35.4.12.2 Resource definition . 86g35.4.12.3 Resource methods . 86g35.4.12.3.1 POST . 86g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)6 5.4.12.3.

29、2 GET . 86g35.4.12.3.3 PUT . 87g35.4.12.3.4 PATCH 87g35.4.12.3.5 DELETE 87g35.4.13 Resource: Individual VNF LCM operation occurrence 87g35.4.13.1 Description 87g35.4.13.2 Resource definition . 87g35.4.13.3 Resource methods . 88g35.4.13.3.1 POST . 88g35.4.13.3.2 GET . 88g35.4.13.3.3 PUT . 88g35.4.13.

30、3.4 PATCH 88g35.4.13.3.5 DELETE 89g35.4.14 Resource: Retry operation task . 89g35.4.14.1 Description 89g35.4.14.2 Resource definition . 89g35.4.14.3 Resource methods . 89g35.4.14.3.1 POST . 89g35.4.14.3.2 GET . 90g35.4.14.3.3 PUT . 90g35.4.14.3.4 PATCH 90g35.4.14.3.5 DELETE 90g35.4.15 Resource: Roll

31、back operation task 91g35.4.15.1 Description 91g35.4.15.2 Resource definition . 91g35.4.15.3 Resource methods . 91g35.4.15.3.1 POST . 91g35.4.15.3.2 GET . 92g35.4.15.3.3 PUT . 92g35.4.15.3.4 PATCH 92g35.4.15.3.5 DELETE 92g35.4.16 Resource: Fail operation task 93g35.4.16.1 Description 93g35.4.16.2 Re

32、source definition . 93g35.4.16.3 Resource methods . 93g35.4.16.3.1 POST . 93g35.4.16.3.2 GET . 94g35.4.16.3.3 PUT . 94g35.4.16.3.4 PATCH 94g35.4.16.3.5 DELETE 94g35.4.17 Resource: Cancel operation task . 95g35.4.17.1 Description 95g35.4.17.2 Resource definition . 95g35.4.17.3 Resource methods . 95g3

33、5.4.17.3.1 POST . 95g35.4.17.3.2 GET . 96g35.4.17.3.3 PUT . 96g35.4.17.3.4 PATCH 96g35.4.17.3.5 DELETE 97g35.4.18 Resource: Subscriptions 97g35.4.18.1 Description 97g35.4.18.2 Resource definition . 97g35.4.18.3 Resource methods . 97g35.4.18.3.1 POST . 97g35.4.18.3.2 GET . 98g35.4.18.3.3 PUT . 99g35.

34、4.18.3.4 PATCH 99g35.4.18.3.5 DELETE 99g35.4.19 Resource: Individual subscription . 99g35.4.19.1 Description 99g35.4.19.2 Resource definition . 99g35.4.19.3 Resource methods . 100g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)7 5.4.19.3.1 POST . 100g35.4.19.3.2 GET . 100g35.4.19.3.3 PUT . 100g35.4.19.3.

35、4 PATCH 100g35.4.19.3.5 DELETE 100g35.4.20 Resource: Notification endpoint . 101g35.4.20.1 Description 101g35.4.20.2 Resource definition . 101g35.4.20.3 Resource methods . 101g35.4.20.3.1 POST . 101g35.4.20.3.2 GET . 102g35.4.20.3.3 PUT . 103g35.4.20.3.4 PATCH 103g35.4.20.3.5 DELETE 103g35.5 Data mo

36、del . 103g35.5.1 Introduction. 103g35.5.2 Resource and notification data types 103g35.5.2.1 Introduction . 103g35.5.2.2 Type: VnfInstance . 103g35.5.2.3 Type: CreateVnfRequest . 106g35.5.2.4 Type: InstantiateVnfRequest . 107g35.5.2.5 Type: ScaleVnfRequest . 107g35.5.2.6 Type: ScaleVnfToLevelRequest

37、. 108g35.5.2.7 Type: ChangeVnfFlavourRequest. 108g35.5.2.8 Type: TerminateVnfRequest . 109g35.5.2.9 Type: HealVnfRequest 109g35.5.2.10 Type: OperateVnfRequest. 110g35.5.2.11 Type: ChangeExtVnfConnectivityRequest . 110g35.5.2.12 Type: VnfInfoModifications . 111g35.5.2.13 Type: VnfLcmOpOcc 112g35.5.2.

38、14 Type: CancelMode 113g35.5.2.15 Type: LccnSubscriptionRequest . 113g35.5.2.16 Type: LccnSubscription 114g35.5.2.17 Type: VnfLcmOperationOccurrenceNotification . 114g35.5.2.18 Type: VnfIdentifierCreationNotification 116g35.5.2.19 Type: VnfIdentifierDeletionNotification 116g35.5.3 Referenced structu

39、red data types 116g35.5.3.1 Introduction . 116g35.5.3.2 Type: ExtVirtualLinkInfo . 117g35.5.3.3 Type: ExtManagedVirtualLinkInfo . 117g35.5.3.4 Type: ScaleInfo . 117g35.5.3.5 Type: VnfcResourceInfo . 118g35.5.3.6 Type: VnfVirtualLinkResourceInfo 118g35.5.3.7 Type: VirtualStorageResourceInfo . 119g35.

40、5.3.8 Type: VnfLinkPort 119g35.5.3.9 Type: ExtLinkPort . 120g35.5.3.10 Type: NetworkAddressInfo . 120g35.5.3.11 Type: MonitoringParameter 120g35.5.3.12 Type: LifecycleChangeNotificationsFilter 121g35.5.3.13 Type: AffectedVnfc 122g35.5.3.14 Type: AffectedVirtualLink 123g35.5.3.15 Type: AffectedVirtua

41、lStorage . 123g35.5.3.16 Type: LccnLinks . 124g35.5.4 Referenced simple data types and enumerations 124g35.5.4.1 Introduction . 124g35.5.4.2 Simple data types 124g35.5.4.3 Enumeration: VnfOperationalStateType . 124g35.5.4.4 Enumeration: StopType 124g35.5.4.5 Enumeration: LcmOperationStateType . 125g

42、35.5.4.6 Enumeration: CancelModeType . 125g35.6 Handling of errors during VNF lifecycle management operations . 125g35.6.1 Basic concepts (informative) 125g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)8 5.6.1.1 Motivation . 125g35.6.1.2 Failure resolution strategies: Retry and Rollback . 126g35.6.1.3 E

43、rror handling at VNFM and NFVO 126g35.6.2 States and state transitions of a VNF lifecycle management operation occurrence 127g35.6.2.1 General 127g35.6.2.2 States of a VNF lifecycle management operation occurrence . 128g35.6.2.3 Error handling operations that change the state of a VNF lifecycle mana

44、gement operation occurrence . 130g35.6.3 Detailed flows . 131g35.6.3.1 Immediate failure 131g35.6.3.2 Failure in “STARTING“ state . 132g35.6.3.3 Failure during actual LCM operation execution . 132g35.6.3.4 LCM operation cancellation 134g36 VNF Performance Management interface 134g36.1 Description .

45、134g36.2 Resource structure and methods . 134g36.3 Sequence diagrams (informative) . 136g36.3.1 Flow of creating a PM job 136g36.3.2 Flow of querying/reading PM jobs . 136g36.3.3 Flow of deleting a PM job 137g36.3.4 Flow of obtaining performance reports . 138g36.3.5 Flow of creating a threshold . 13

46、9g36.3.6 Flow of querying/reading thresholds 139g36.3.7 Flow of deleting thresholds . 140g36.3.8 Flow of managing subscriptions . 141g36.3.9 Flow of sending notifications 142g36.4 Resources . 143g36.4.1 Introduction. 143g36.4.2 Resource: PM jobs 143g36.4.2.1 Description 143g36.4.2.2 Resource definit

47、ion . 143g36.4.2.3 Resource methods . 143g36.4.2.3.1 POST . 143g36.4.2.3.2 GET . 144g36.4.2.3.3 PUT . 145g36.4.2.3.4 PATCH 145g36.4.2.3.5 DELETE 145g36.4.3 Resource: Individual PM job 145g36.4.3.1 Description 145g36.4.3.2 Resource definition . 145g36.4.3.3 Resource methods . 146g36.4.3.3.1 POST . 14

48、6g36.4.3.3.2 GET . 146g36.4.3.3.3 PUT . 146g36.4.3.3.4 PATCH 146g36.4.3.3.5 DELETE 146g36.4.4 Resource: Individual performance report . 147g36.4.4.1 Description 147g36.4.4.2 Resource definition . 147g36.4.4.3 Resource methods . 148g36.4.4.3.1 POST . 148g36.4.4.3.2 GET . 148g36.4.4.3.3 PUT . 148g36.4

49、.4.3.4 PATCH 148g36.4.4.3.5 DELETE 148g36.4.5 Resource: Thresholds 148g36.4.5.1 Description 148g36.4.5.2 Resource definition . 149g36.4.5.3 Resource methods . 149g36.4.5.3.1 POST . 149g36.4.5.3.2 GET . 149g3ETSI ETSI GS NFV-SOL 003 V2.3.1 (2017-07)9 6.4.5.3.3 PUT . 150g36.4.5.3.4 PATCH 150g36.4.5.3.5 DELETE 150g36.4.6 Resource: Individual threshold . 150g36.4.6.1 Description 150g36.4.6.2 Resource definition . 150g36.4.6.3 Resource methods . 151g36.4.6.3.1 POST . 151g36.4.6.3.2 GET . 151g36.4.6.3.3 PUT . 151g36.4.6.3.4 PATCH 151g36.4.6.3.5 DELETE 152g36.4.7 Resource: Subscriptio