ETSI TS 123 222-2018 LTE 5G Common API Framework for 3GPP Northbound APIs (V15 2 0 3GPP TS 23 222 version 15 2 0 Release 15).pdf

1、 ETSI TS 123 222 V15.2.0 (2018-07) LTE; 5G; Common API Framework for 3GPP Northbound APIs (3GPP TS 23.222 version 15.2.0 Release 15) TECHNICAL SPECIFICATION ETSI ETSI TS 123 222 V15.2.0 (2018-07)13GPP TS 23.222 version 15.2.0 Release 15Reference RTS/TSGS-0623222vf20 Keywords 5G,LTE ETSI 650 Route de

2、s 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.etsi.org/

3、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 difference in co

4、ntents 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 stat

5、us. 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/CommiteeSupportStaff.aspx C

6、opyright 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.

7、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 benefit of its Mem

8、bers 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 TS 123 222 V15.2.0 (2018-07)23GPP TS 23.222 version 15.2.0 Release 15Intellectual Property Rights Essential

9、 patents IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs); Es

10、sential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards“, which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server (https:/ipr.etsi.org/). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carrie

11、d out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present document. Trademarks The present document may include trademarks and/or tradenames which

12、are asserted and/or registered by their owners. ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does not constitute an endo

13、rsement by ETSI of products, services or organizations associated with those trademarks. Foreword This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities,

14、UMTS identities or GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables. The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under http:/webapp.etsi.org/key/queryform.asp. Modal verbs terminology In the present document “shal

15、l“, “shall not“, “should“, “should not“, “may“, “need not“, “will“, “will not“, “can“ and “cannot“ are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of provisions). “must“ and “must not“ are NOT allowed in ETSI deliverables except when used

16、in direct citation. ETSI ETSI TS 123 222 V15.2.0 (2018-07)33GPP TS 23.222 version 15.2.0 Release 15Contents Intellectual Property Rights 2g3Foreword . 2g3Modal verbs terminology 2g3Foreword . 9g3Introduction 9g31 Scope 10g32 References 10g33 Definitions and abbreviations . 10g33.1 Definitions 10g33.

17、2 Abbreviations . 11g34 Architectural requirements . 12g34.1 General . 12g34.1.1 Introduction. 12g34.1.2 Requirements 12g34.1.3 Requirements for supporting 3rdparty API providers . 12g34.2 Service API publish and discover . 12g34.2.1 Introduction. 12g34.2.2 Requirements 12g34.3 Security 12g34.3.1 In

18、troduction. 12g34.3.2 Requirements 13g34.3.3 Additional requirements for 3rdparty API provider 13g34.4 Charging . 13g34.4.1 Introduction. 13g34.4.2 Requirements 13g34.5 Operations, Administration and Maintenance 13g34.5.1 Introduction. 13g34.5.2 Requirements 14g34.6 Service API invocation monitoring

19、 14g34.6.1 Introduction. 14g34.6.2 Requirements 14g34.7 Logging 14g34.7.1 Introduction. 14g34.7.2 Logging events related to service API invocations . 14g34.7.3 Logging events related to API invoker onboarding 14g34.7.4 Logging events related to API invoker interaction with the CAPIF . 15g34.8 Auditi

20、ng service API invocation 15g34.8.1 Introduction. 15g34.8.2 Requirements 15g34.9 Onboarding API invoker 15g34.9.1 Introduction. 15g34.9.2 Requirements 15g34.10 Policy configuration . 15g34.10.1 Introduction. 15g34.10.2 Requirements 15g34.11 Protocol design . 15g34.11.1 Introduction. 15g34.11.2 Requi

21、rements 15g35 Involved business relationships 16g36 Functional model 16g36.1 General . 16g36.2 Functional model description . 16g3ETSI ETSI TS 123 222 V15.2.0 (2018-07)43GPP TS 23.222 version 15.2.0 Release 156.3 Functional entities description 17g36.3.1 General 17g36.3.2 API invoker . 17g36.3.3 CAP

22、IF core function . 18g36.3.4 API exposing function 18g36.3.5 API publishing function 18g36.3.6 API management function 18g36.4 Reference points . 19g36.4.1 General 19g36.4.2 Reference point CAPIF-1 (between the API invoker and the CAPIF core function) . 19g36.4.3 Reference point CAPIF-1e (between th

23、e API invoker and the CAPIF core function) 19g36.4.4 Reference point CAPIF-2 (between the API invoker and the API exposing function) . 19g36.4.5 Reference point CAPIF-2e (between the API invoker and the API exposing function) . 20g36.4.6 Reference point CAPIF-3 (between the API exposing function and

24、 the CAPIF core function) . 20g36.4.7 Reference point CAPIF-4 (between the API publishing function and the CAPIF core function) 20g36.4.8 Reference point CAPIF-5 (between the API management function and the CAPIF core function) . 20g37 Application of functional model to deployments . 21g37.1 General

25、 . 21g37.2 Centralized deployment 21g37.3 Distributed deployment 21g38 Procedures and information flows 24g38.1 Onboarding the API invoker to the CAPIF 24g38.1.1 General 24g38.1.2 Information flows . 24g38.1.2.1 Onboard API invoker request 24g38.1.2.2 Onboard API invoker response . 25g38.1.3 Procedu

26、re 25g38.2 Offboarding the API invoker from the CAPIF . 26g38.2.1 General 26g38.2.2 Information flows . 26g38.2.2.1 Offboard API invoker request . 26g38.2.2.2 Offboard API invoker response . 26g38.2.3 Procedure 26g38.3 Publish service APIs . 27g38.3.1 General 27g38.3.2 Information flows . 27g38.3.2.

27、1 Service API publish request 27g38.3.2.2 Service API publish response 28g38.3.3 Procedure 28g38.4 Unpublish service APIs 28g38.4.1 General 28g38.4.2 Information flows . 29g38.4.2.1 Service API unpublish request 29g38.4.2.2 Service API unpublish response 29g38.4.3 Procedure 29g38.5 Retrieve service

28、APIs . 30g38.5.1 General 30g38.5.2 Information flows . 30g38.5.2.1 Service API get request . 30g38.5.2.2 Service API get response 30g38.5.3 Procedure 30g38.6 Update service APIs . 31g38.6.1 General 31g38.6.2 Information flows . 31g38.6.2.1 Service API update request . 31g38.6.2.2 Service API update

29、response . 32g38.6.3 Procedure 32g38.7 Discover service APIs 32g38.7.1 General 32g38.7.2 Information flows . 33g3ETSI ETSI TS 123 222 V15.2.0 (2018-07)53GPP TS 23.222 version 15.2.0 Release 158.7.2.1 Service API discover request 33g38.7.2.2 Service API discover response 33g38.7.3 Procedure 33g38.8 S

30、ubscription, unsubscription and notifications for the CAPIF events 34g38.8.1 General 34g38.8.2 Information flows . 34g38.8.2.1 Event subscription request 34g38.8.2.2 Event subscription response 35g38.8.2.3 Event notification 35g38.8.2.4 Event notification acknowledgement 35g38.8.2.5 Event unsubscrip

31、tion request 35g38.8.2.6 Event unsubscription response 36g38.8.3 Procedure for CAPIF event subscription 36g38.8.4 Procedure for CAPIF event notifications 36g38.8.5 Procedure for CAPIF event unsubscription 37g38.8.6 List of CAPIF events 38g38.9 Revoking subscription of the CAPIF events 38g38.9.1 Gene

32、ral 38g38.9.2 Information flows . 38g38.9.2.1 Subscription revoke notification . 38g38.9.2.2 Subscription revoke notification acknowledgement . 39g38.9.3 Procedure 39g38.10 Authentication between the API invoker and the CAPIF core function . 39g38.10.1 General 39g38.10.2 Information flows . 39g38.10

33、.3 Procedure 39g38.11 API invoker obtaining authorization to access service API . 40g38.11.1 General 40g38.11.2 Information flows . 40g38.11.3 Procedure 40g38.12 AEF obtaining service API access control policy 41g38.12.1 General 41g38.12.2 Information flows . 41g38.12.2.1 Obtain access control polic

34、y request . 41g38.12.2.2 Obtain access control policy response. 41g38.12.3 Procedure 42g38.13 Topology hiding . 42g38.13.1 General 42g38.13.2 Information flows . 43g38.13.2.1 Service API invocation request (API invoker AEF-1) . 43g38.13.2.2 Service API invocation request (AEF-1 AEF-2) 43g38.13.2.3 S

35、ervice API invocation response (AEF-2 AEF-1) . 43g38.13.2.4 Service API invocation response (AEF-1 API invoker) . 43g38.13.3 Procedure 43g38.14 Authentication between the API invoker and the AEF prior to service API invocation 44g38.14.1 General 44g38.14.2 Information flows . 44g38.14.3 Procedure 44

36、g38.15 Authentication between the API invoker and the AEF upon the service API invocation 45g38.15.1 General 45g38.15.2 Information flows . 45g38.15.2.1 Service API invocation request with authentication information 45g38.15.2.2 Service API invocation response . 46g38.15.3 Procedure 46g38.16 API inv

37、oker authorization to access service APIs 47g38.16.1 General 47g38.16.2 Information flows . 47g38.16.2.1 Service API invocation request . 47g38.16.2.2 Service API invocation response . 47g38.16.3 Procedure 47g38.17 CAPIF access control . 48g38.17.1 General 48g3ETSI ETSI TS 123 222 V15.2.0 (2018-07)6

38、3GPP TS 23.222 version 15.2.0 Release 158.17.2 Information flows . 49g38.17.2.1 Service API invocation request . 49g38.17.2.2 Service API invocation response . 49g38.17.3 Procedure 49g38.18 CAPIF access control with cascaded AEFs 50g38.18.1 General 50g38.18.2 Information flows . 50g38.18.2.1 Service

39、 API invocation request . 50g38.18.2.2 Service API invocation response . 50g38.18.3 Procedure 51g38.19 Logging service API invocations . 51g38.19.1 General 51g38.19.2 Information flows . 51g38.19.2.1 API invocation log request 51g38.19.2.2 API invocation log response . 52g38.19.3 Procedure 52g38.20

40、Charging the invocation of service APIs 53g38.20.1 General 53g38.20.2 Information flows . 53g38.20.3 Procedure 53g38.21 Monitoring service API invocation 53g38.21.1 General 53g38.21.2 Information flows . 53g38.21.2.1 Monitoring service API event notification 53g38.21.2.2 Monitoring service API event

41、 notification acknowledgement 54g38.21.3 Procedure 54g38.22 Auditing service API invocation 54g38.22.1 General 54g38.22.2 Information flows . 54g38.22.2.1 Query service API log request 54g38.22.2.2 Query service API log response 55g38.22.3 Procedure 55g38.23 CAPIF revoking API invoker authorization

42、. 56g38.23.1 General 56g38.23.2 Information flows . 56g38.23.2.1 Revoke API invoker authorization request . 56g38.23.2.2 Revoke API invoker authorization response . 56g38.23.2.3 Revoke API invoker authorization notify . 56g38.23.3 Procedure for CAPIF revoking API invoker authorization initiated by A

43、EF . 56g38.23.4 Procedure for CAPIF revoking API invoker authorization initiated by CAPIF core function . 57g39 API consistency guidelines 58g39.1 General . 58g39.2 Fundamental API Guidelines . 58g39.3 Architecture design considerations . 59g310 CAPIF core function APIs . 60g310.1 General . 60g310.2

44、 CAPIF_Discover_Service_API API 60g310.2.1 General 60g310.2.2 Discover_Service_API operation 60g310.2.3 Event_Subscription operation . 61g310.2.4 Event_Notification operation 61g310.2.5 Event_Unsubscription operation . 61g310.3 CAPIF_Publish_Service_API API . 61g310.3.1 General 61g310.3.2 Publish_Se

45、rvice_API operation 61g310.3.3 Unpublish_Service_API operation . 62g310.3.4 Update_Service_API operation 62g310.3.5 Get_Service_API operation 62g310.3.6 Event_Subscription operation . 62g310.3.7 Event_Notification operation 62g3ETSI ETSI TS 123 222 V15.2.0 (2018-07)73GPP TS 23.222 version 15.2.0 Rel

46、ease 1510.3.8 Event_Unsubscription operation . 63g310.4 CAPIF_Events API 63g310.4.1 General 63g310.4.2 Event_Subscription operation . 63g310.4.3 Event_Notification operation 64g310.4.4 Event_Unsubscription operation . 64g310.5 CAPIF_API_invoker_management API 64g310.5.1 General 64g310.5.2 Onboard_AP

47、I_Invoker operation 64g310.5.3 Offboard_API_Invoker operation . 64g310.5.4 Event_Subscription operation . 65g310.5.5 Event_Notification operation 65g310.5.6 Event_Unsubscription operation . 65g310.6 CAPIF_Authentication_Authorization API . 65g310.6.1 General 65g310.6.2 Authenticate operation 65g310.

48、6.3 Obtain_Authorization operation . 66g310.7 CAPIF_Monitoring API . 66g310.7.1 General 66g310.7.2 Event_Subscription operation . 66g310.7.3 Monitoring_Service_API_Notification operation . 66g310.7.4 Event_Unsubscription operation . 66g310.8 CAPIF_Logging_API_Invocation API 67g310.8.1 General 67g310

49、.8.2 Log_API_Invocation operation 67g310.9 CAPIF_Auditing API . 67g310.9.1 General 67g310.9.2 Query_ API_Invocation_Log operation 67g3Annex A (informative): Overview of CAPIF operations. 68g3Annex B (informative): CAPIF relationship with network exposure aspects of 3GPP systems 70g3B.0 CAPIF utilization by service API provider 70g3B.1 CAPIF relationship with 3GPP EPS network exposure . 71g3B.1.1 General . 71g3B.1.2 Deployment models 71g3B.1.2.1 General 71g3B.1.2.2 SCEF implements the CAPIF architecture . 71g3B.1.2.3 SCEF implements the service specific aspect compliant