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

1、 ETSI TS 129 222 V15.0.0 (2018-07) 5G; Common API Framework for 3GPP Northbound APIs (3GPP TS 29.222 version 15.0.0 Release 15) TECHNICAL SPECIFICATION ETSI ETSI TS 129 222 V15.0.0 (2018-07)13GPP TS 29.222 version 15.0.0 Release 15Reference DTS/TSGC-0329222vf00 Keywords 5G ETSI 650 Route des Luciole

2、s 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/standards

3、-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 contents be

4、tween 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. Infor

5、mation 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 Copyright

6、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 copyr

7、ight 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 Members and

8、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 129 222 V15.0.0 (2018-07)23GPP TS 29.222 version 15.0.0 Release 15Intellectual Property Rights Essential patents

9、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); Essential,

10、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 carried out by

11、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 are asser

12、ted 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 endorsement b

13、y 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, UMTS iden

14、tities 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 “shall“, “shal

15、l 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 in direct

16、 citation. ETSI ETSI TS 129 222 V15.0.0 (2018-07)33GPP TS 29.222 version 15.0.0 Release 15Contents Intellectual Property Rights 2g3Foreword . 2g3Modal verbs terminology 2g3Foreword . 10g31 Scope 11g32 References 11g33 Definitions and abbreviations . 11g33.1 Definitions 11g33.2 Abbreviations . 12g34

17、Overview 12g34.1 Introduction 12g34.2 Service Architecture . 12g34.3 Functional Entities 13g34.3.1 API invoker . 13g34.3.2 CAPIF core function . 14g34.3.3 API exposing function 14g34.3.4 API publishing function 14g34.3.5 API management function 14g35 Services offered by the CAPIF Core Function . 15g

18、35.1 Introduction of Services . 15g35.2 CAPIF_Discovery_Service_API 15g35.2.1 Service Description . 15g35.2.1.1 Overview . 15g35.2.2 Service Operations 16g35.2.2.1 Introduction . 16g35.2.2.2 Discover_Service_API 16g35.2.2.2.1 General 16g35.2.2.2.2 API invoker discovering service API using Discover_S

19、ervice_API service operation . 16g35.3 CAPIF_Publish_Service_API 16g35.3.1 Service Description . 16g35.3.1.1 Overview . 16g35.3.2 Service Operations 17g35.3.2.1 Introduction . 17g35.3.2.2 Publish_Service_API 17g35.3.2.2.1 General 17g35.3.2.2.2 API publishing function publishing service APIs on CAPIF

20、 core function using Publish_Service_API service operation 17g35.3.2.3 Unpublish_Service_API 17g35.3.2.3.1 General 17g35.3.2.3.2 API publishing function un-publishing service APIs from CAPIF core function using Unpublish_Service_API service operation 17g35.3.2.4 Retrieve_Service_API . 18g35.3.2.4.1

21、General 18g35.3.2.4.2 API publishing function retrieving service APIs from CAPIF core function using Retrieve_Service_API service operation . 18g35.3.2.5 Update_Service_API . 18g35.3.2.5.1 General 18g35.3.2.5.2 API publishing function updating published service APIs on CAPIF core function using Upda

22、te_Service_API service operation . 18g35.4 CAPIF_Events_API . 18g35.4.1 Service Description . 18g35.4.1.1 Overview . 18g35.4.2 Service Operations 19g35.4.2.1 Introduction . 19g3ETSI ETSI TS 129 222 V15.0.0 (2018-07)43GPP TS 29.222 version 15.0.0 Release 155.4.2.2 Event_Subscription_API . 19g35.4.2.2

23、.1 General 19g35.4.2.2.2 Subscribing to CAPIF events using Event_Subscription service operation 19g35.4.2.3 Event_Unsubscription_API . 19g35.4.2.3.1 General 19g35.4.2.3.2 Unsubscribing from CAPIF events using Event_Unsubscription service operation . 19g35.4.2.4 Event_Notification_API 19g35.4.2.4.1 G

24、eneral 19g35.4.2.4.2 Notifying CAPIF events using Event_Notification service operation . 20g35.5 CAPIF_API_Invoker_Management_API . 20g35.5.1 Service Description . 20g35.5.1.1 Overview . 20g35.5.2 Service Operations 20g35.5.2.1 Introduction . 20g35.5.2.2 Onboard_API_Invoker_API 20g35.5.2.2.1 General

25、 20g35.5.2.2.2 API invoker on-boarding itself as a recognized user of CAPIF using Onboard_API_Invoker service operation 20g35.5.2.3 Offboard_API_Invoker_API . 21g35.5.2.3.1 General 21g35.5.2.3.2 API invoker off-boarding itself as a recognized user of CAPIF using Offboard_API_Invoker service operatio

26、n 21g35.6 CAPIF_Authentication_Authorization_API. 21g35.6.1 Service Description . 21g35.6.1.1 Overview . 21g35.6.2 Service Operations 22g35.6.2.1 Introduction . 22g35.6.2.2 Service_Security_Method_Request_API 22g35.6.2.2.1 General 22g35.6.2.2.2 Request service API security method from CAPIF using Se

27、rvice_Security_Method_Request service operation 22g35.6.2.2.3 Obtain authorization using Obtain_Authorization service operation. 22g35.6.2.2.4 Obtain API invokers security information using Obtain_API_Invoker_Info service operation . 23g35.6.2.2.5 Invalidate authorization using Invalidate_Authorizat

28、ion service operation 23g35.7 CAPIF_Monitoring_API 23g35.8 CAPIF_Logging_API_Invocation_API . 23g35.8.1 Service Description . 23g35.8.1.1 Overview . 23g35.8.2 Service Operations 23g35.8.2.1 Introduction . 23g35.8.2.2 Log_API_Invocation_API 23g35.8.2.2.1 General 23g35.8.2.2.2 Logging service API invo

29、cations using Log_API_Invocation service operation 23g35.9 CAPIF_Auditing_API 24g35.9.1 Service Description . 24g35.9.1.1 Overview . 24g35.9.2 Service Operations 24g35.9.2.1 Introduction . 24g35.9.2.2 Query_Invocation_Logs_API . 24g35.9.2.2.1 General 24g35.9.2.2.2 Query API invocation information lo

30、gs using Query_Invocation_Logs service operation . 24g35.10 CAPIF_Access_Control_Policy_API . 25g35.10.1 Service Description . 25g35.10.1.1 Overview . 25g35.10.2 Service Operations 25g35.10.2.1 Introduction . 25g35.10.2.2 Obtain_Access_Control_Policy 25g35.10.2.2.1 General 25g35.10.2.2.2 API exposin

31、g function obtaining access control policy from the CAPIF core function using Obtain_Access_Control_Policy service operation 25g35.10.3 Related Events 25g3ETSI ETSI TS 129 222 V15.0.0 (2018-07)53GPP TS 29.222 version 15.0.0 Release 156 Services offered by the API exposing function 25g36.1 Introducti

32、on of Services . 25g36.2 AEF_Authentication_API 26g36.2.1 Service Description . 26g36.2.1.1 Overview . 26g36.2.2 Service Operations 26g36.2.2.1 Introduction . 26g36.2.2.2 Authentication_Initiation_Request_API . 26g36.2.2.2.1 General 26g36.2.2.2.2 API invoker initiating authentication using Authentic

33、ation_Initiation_Request service operation 26g37 CAPIF Design Aspects Common for All APIs 26g37.1 General . 26g37.2 Data Types 27g37.2.1 General 27g37.2.2 Referenced structured data types 27g37.2.3 Referenced Simple data types and enumerations 27g37.3 Usage of HTTP . 27g37.4 Content type . 27g37.5 U

34、RI structure 28g37.6 Notifications . 28g37.7 Error handling 28g37.8 Feature negotiation . 28g37.9 HTTP headers . 28g38 CAPIF API Definition 29g38.1 CAPIF_Discovery_Service_API 29g38.1.1 API URI 29g38.1.2 Resources 29g38.1.2.1 Overview . 29g38.1.2.2 Resource: All published service APIs . 29g38.1.2.2.

35、1 Description 29g38.1.2.2.2 Resource Definition . 29g38.1.2.2.3 Resource Standard Methods 30g38.1.2.2.4 Resource Custom Operations 30g38.1.2.2.4.1 Overview 30g38.1.2.2.4.2 Operation: discover 30g38.1.2.2.4.2.1 Description . 30g38.1.2.2.4.2.2 Operation Definition 30g38.1.3 Notifications . 30g38.1.4 D

36、ata Model . 30g38.1.4.1 General 30g38.1.4.2 Structured data types . 31g38.1.4.2.1 Introduction . 31g38.1.4.2.2 Type: APIQuery 31g38.1.4.2.3 Type: DiscoveredAPIs . 31g38.1.4.3 Simple data types and enumerations . 31g38.1.5 Error Handling 31g38.1.6 Feature negotiation . 31g38.2 CAPIF_Publish_Service_A

37、PI 32g38.2.1 API URI 32g38.2.2 Resources 32g38.2.2.1 Overview . 32g38.2.2.2 Resource: APF published APIs . 33g38.2.2.2.1 Description 33g38.2.2.2.2 Resource Definition . 33g38.2.2.2.3 Resource Standard Methods 33g38.2.2.2.3.1 POST 33g38.2.2.2.3.2 GET 33g38.2.2.2.4 Resource Custom Operations 34g38.2.2

38、.3 Resource: Individual APF published API . 34g3ETSI ETSI TS 129 222 V15.0.0 (2018-07)63GPP TS 29.222 version 15.0.0 Release 158.2.2.3.1 Description 34g38.2.2.3.2 Resource Definition . 34g38.2.2.3.3 Resource Standard Methods 34g38.2.2.3.3.1 GET 34g38.2.2.3.3.2 PUT 35g38.2.2.3.3.3 DELETE 35g38.2.2.3.

39、4 Resource Custom Operations 35g38.2.3 Notifications . 35g38.2.4 Data Model . 36g38.2.4.1 General 36g38.2.4.2 Structured data types . 36g38.2.4.2.1 Introduction . 36g38.2.4.2.2 Type: ServiceAPIDescription 36g38.2.4.2.3 Type: InterfaceDescription 37g38.2.4.3 Simple data types and enumerations . 37g38

40、.2.4.3.1 Introduction . 37g38.2.4.3.2 Simple data types . 37g38.2.4.3.3 Enumeration: Protocol . 37g38.2.4.3.4 Enumeration: DataFormat . 37g38.2.5 Error Handling 37g38.2.6 Feature negotiation . 37g38.3 CAPIF_Events_API . 38g38.3.1 API URI 38g38.3.2 Resources 38g38.3.2.1 Overview . 38g38.3.2.2 Resourc

41、e: CAPIF Events Subscriptions 38g38.3.2.2.1 Description 38g38.3.2.2.2 Resource Definition . 39g38.3.2.2.3 Resource Standard Methods 39g38.3.2.2.3.1 POST 39g38.3.2.2.4 Resource Custom Operations 39g38.3.2.3 Resource: Individual CAPIF Events Subscription 39g38.3.2.3.1 Description 39g38.3.2.3.2 Resourc

42、e Definition . 39g38.3.2.3.3 Resource Standard Methods 40g38.3.2.3.3.1 DELETE 40g38.3.2.3.4 Resource Custom Operations 40g38.3.3 Notifications . 40g38.3.3.1 General 40g38.3.3.2 Event Notification . 40g38.3.3.2.1 Description 40g38.3.3.2.2 Notification definition . 41g38.3.4 Data Model . 41g38.3.4.1 G

43、eneral 41g38.3.4.2 Structured data types . 41g38.3.4.2.1 Introduction . 41g38.3.4.2.2 Type: EventSubscription . 42g38.3.4.2.3 Type: EventNotification 42g38.3.4.3 Simple data types and enumerations . 42g38.3.4.3.1 Introduction . 42g38.3.4.3.2 Simple data types . 42g38.3.4.3.3 Enumeration: CAPIFEvent

44、43g38.3.5 Error Handling 43g38.3.6 Feature negotiation . 43g38.4 CAPIF_API_Invoker_Management_API . 43g38.4.1 API URI 43g38.4.2 Resources 44g38.4.2.1 Overview . 44g38.4.2.2 Resource: On-boarded API invokers . 44g38.4.2.2.1 Description 44g38.4.2.2.2 Resource Definition . 44g38.4.2.2.3 Resource Standa

45、rd Methods 44g3ETSI ETSI TS 129 222 V15.0.0 (2018-07)73GPP TS 29.222 version 15.0.0 Release 158.4.2.2.3.1 POST 44g38.4.2.2.4 Resource Custom Operations 45g38.4.2.3 Resource: Individual On-boarded API Invoker . 45g38.4.2.3.1 Description 45g38.4.2.3.2 Resource Definition . 45g38.4.2.3.3 Resource Stand

46、ard Methods 45g38.4.2.3.3.1 DELETE 45g38.3.2.3.4 Resource Custom Operations 46g38.4.3 Notifications . 46g38.4.3.1 General 46g38.4.3.2 On-boarding Notification 46g38.4.3.2.1 Description 46g38.4.3.2.2 Notification definition . 46g38.4.4 Data Model . 47g38.4.4.1 General 47g38.4.4.2 Structured data type

47、s . 48g38.4.4.2.1 Introduction . 48g38.4.4.2.2 Type: APIInvokerEnrolmentDetails 48g38.4.4.2.3 Type: OnboardingNotificationDestination 48g38.4.4.2.4 Type: APIList 48g38.4.4.2.5 Type: OnboardingInformation . 49g38.4.4.2.6 Type: OnboardingRequestAck 49g38.4.4.2.7 Type: CAPIFOnboardingNotification . 49g

48、38.4.4.3 Simple data types and enumerations . 49g38.4.5 Error Handling 49g38.4.6 Feature negotiation . 49g38.5 CAPIF_Authentication_Authorization_API. 50g38.5.1 API URI 50g38.5.2 Resources 50g38.5.2.1 Overview . 50g38.5.2.2 Resource: Trusted API invokers . 51g38.5.2.2.1 Description 51g38.5.2.2.2 Res

49、ource Definition . 51g38.5.2.2.3 Resource Standard Methods 51g38.5.2.2.3.1 POST 51g38.5.2.2.4 Resource Custom Operations 51g38.5.2.3 Resource: Individual trusted API invokers . 52g38.5.2.3.1 Description 52g38.5.2.3.2 Resource Definition . 52g38.5.2.3.3 Resource Standard Methods 52g38.5.2.3.3.1 GET 52g38.5.2.3.3.2 DELETE 52g38.5.2.3.4 Resource Custom Operations 53g38.5.3 Notifications . 53g38.5.3.1 General 53g38.5.3.2 Authorization revoked notification . 53g38.5.3.2.1 Description 53g38.5.3.2.2 Notification definition . 53g38.5.4 Data Model . 54g38.5.4.1 General 54g38.5.4.2 Str