ETSI GS MEC 014-2018 Mobile Edge Computing (MEC) UE Identity API (V1 1 1).pdf

1、 ETSI GS MEC 014 V1.1.1 (2018-02) Mobile Edge Computing (MEC); UE Identity API Disclaimer The present document has been produced and approved by the Mobile Edge Computing (MEC) ETSI Industry Specification Group (ISG) and represents the views of those members who participated in this ISG. It does not

2、 necessarily represent the views of the entire ETSI membership. GROUP SPECIFICATION ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 2 Reference DGS/MEC-0014UEidentityAPI Keywords API, MEC, UE Identity ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65

3、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-search The present document may be made available in electronic versions and/or in

4、 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 only prevailing document is the print of t

5、he 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. Information on the current status of this and other ETSI documents is available at https

6、:/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 Notification No part may be reproduced or utilized in any form or by any means, ele

7、ctronic 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 2018.

8、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 of the 3GPP Organizational Partners. oneM2M logo is protected for the benefit of it

9、s Members. GSMand the GSM logo are trademarks registered and owned by the GSM Association. ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 3 Contents Intellectual Property Rights 4g3Foreword . 4g3Modal verbs terminology 4g31 Scope 5g32 References 5g32.1 Normative references . 5g32.2 Informative references 5g3

10、3 Definitions and abbreviations . 6g33.1 Definitions 6g33.2 Abbreviations . 6g34 Overview 6g35 Description of the feature (informative) . 6g35.1 Introduction 6g35.2 Sequence diagrams . 6g35.2.1 General 6g35.2.2 UE Identity tag registration . 6g35.2.3 UE Identity tag de-registration 7g36 Data model E

11、ssential, 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 carri

12、ed 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

13、 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 end

14、orsement by ETSI of products, services or organizations associated with those trademarks. Foreword This Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Mobile Edge Computing (MEC). Modal verbs terminology In the present document “shall“, “shall not“, “should“, “

15、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 citation. ETSI ETS

16、I GS MEC 014 V1.1.1 (2018-02) 5 1 Scope The present document focuses on the UE Identity functionality. It describes the related application policy information (including authorization, access control and traffic rule pattern format), information flows, required information and service aggregation pa

17、tterns. The present document specifies the necessary API, data model and data format, considering existing API(s) if applicable. 2 References 2.1 Normative references References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For speci

18、fic references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which are not found to be publicly available in the expected location might be found at https:/docbox.etsi.org/Reference

19、. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are necessary for the application of the present document. 1 ETSI GS MEC 001: “Mobile Edge Computing (MEC); Terminology“. 2 E

20、TSI GS MEC 002: “Mobile Edge Computing (MEC); Technical Requirements“. 3 ETSI GS MEC 009: “Mobile Edge Computing (MEC); General principles for Mobile Edge Service APIs“. 4 IETF RFC 2818: “HTTP Over TLS“. NOTE: Available at https:/tools.ietf.org/html/rfc2818. 5 IETF RFC 5246: “The Transport Layer Sec

21、urity (TLS) Protocol Version 1.2“. NOTE: Available at https:/tools.ietf.org/html/rfc5246. 2.2 Informative references References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. Fo

22、r non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary

23、for the application of the present document but they assist the user with regard to a particular subject area. i.1 OpenAPI Specification. NOTE: Available at https:/ ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 6 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the t

24、erms and definitions given in ETSI GS MEC 001 1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ETSI GS MEC 001 1 and the following apply: API Application Programming Interface HTTP Hypertext Transfer Protocol IETF Internet Engineering Task Force 4 Overv

25、iew The present document specifies the API for the UE Identity feature to support the corresponding requirements defined for the Mobile Edge Computing in ETSI GS MEC 002 2. Clause 5 contains the description of the feature and the information flows of the procedures. Clause 6 describes the data model

26、 and data format applied in the UE Identity API. Clause 7 is the actual API definition of the UE Identity feature. 5 Description of the feature (informative) 5.1 Introduction The purpose of the UE Identity feature is to allow UE specific traffic rules in the mobile edge system. When the mobile edge

27、system supports the UE Identity feature, the mobile edge platform provides the functionality for a mobile edge application to register a tag (representing a UE) or a list of tags. Each tag has been mapped into a specific UE in the mobile network operators system. The mobile edge platform is provided

28、 with the mapping information. How the mapping is realized is outside the scope of the present document. The UE Identity tag registration triggers the mobile edge platform to activate the corresponding traffic rule(s) linked to the tag. Later, if the application does not wish to use the traffic rule

29、 for that user, it may de-register the UE Identity tag by invoking the de-registration procedure. 5.2 Sequence diagrams 5.2.1 General The following clauses describe how mobile edge applications can register and de-register tags as part of UE Identity feature. The related sequence diagrams are presen

30、ted. ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 7 5.2.2 UE Identity tag registration Figure 5.2.2-1 illustrates the message flow for the UE Identity tag registration procedure. The tag is used in UE Identity feature. Figure 5.2.2-1: UE Identity tag registration The UE Identity tag registration procedure

31、consists of the following steps: 1) The mobile edge application instance sends a PUT request with the message body containing the UeIdentityTagInfo data structure with the state set to REGISTERED to the mobile edge platform. The variable appInstanceId is set to the application instance identifier as

32、signed to the mobile edge application instance. 2) The mobile edge platform sends “200 OK“ response with the message body containing the UeIdentityTagInfo data structure with the state set to REGISTERED. Once the tag or the list of tags, is successfully registered in the mobile edge platform the rel

33、ated traffic rules can then be activated. NOTE: It is out of the scope of the present document how the mobile edge application obtains the UE Identity tag(s). 5.2.3 UE Identity tag de-registration Figure 5.2.3-1 illustrates the message flow for the UE Identity tag deregistration procedure. Figure 5.

34、2.3-1: UE Identity tag de-registration The UE Identity tag deregistration procedure consists of the following steps: 1) The mobile edge application instance sends a PUT request with the message body containing the UeIdentityTagInfo data structure with the state set to UNREGISTERED to the mobile edge

35、 platform. The variable appInstanceId is set to the application instance identifier assigned to the mobile edge application instance. 2) The mobile edge platform sends “200 OK“ response with the message body containing the UeIdentityTagInfo data structure with the state set to UNREGISTERED. Once the

36、 tag or the list of tags is successfully deregistered in the mobile edge platform the related traffic rules are then deactivated. ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 8 6 Data model & Data format (normative) 6.1 Introduction The following clauses specify the data types that are used to implement th

37、e UE Identity feature, for which the relevant sequence diagrams are described in clauses 5.2.2 and 5.2.3. 6.2 Resource data types 6.2.1 Introduction This clause defines data structures to be used in resource representations. 6.2.2 Type: UeIdentityTagInfo This type represents the information of UE Id

38、entity tag used in the UE Identity feature. Table 6.2.2-1: Definition of type UeIdentityTagInfo Attribute name Data type Cardinality Description ueIdentityTags Structure (inlined) 1N 1 to N tags presented by a ME Application instance to a ME Platform ueIdentityTag String 1 Specific tag presented by

39、a ME Application instance to a ME Platform state Enum (inlined) 1 The following numeric values are defined: 0 = UNREGISTERED 1 = REGISTERED 6.3 Subscription types In the present document, no subscription data types are defined. 6.4 Notifications types In the present document, no notifications data t

40、ypes are defined. 6.5 Referenced structured data types In the present document, no referenced structured data types are defined. 6.6 Referenced simple data types In the present document, no referenced simple data types are defined. 7 API definition (normative) 7.1 Introduction This clause defines th

41、e resources and operations of the UEIdentity API. ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 9 7.2 Global definitions and resource structure All resource URIs of this API shall have the following root: apiRoot/ui/v1/ The “apiRoot“ is discovered using the service registry. The API shall support HTTP over

42、TLS (also known as HTTPS - see IETF RFC 2818 4). TLS version 1.2 as defined by IETF RFC 5246 5 shall be supported. HTTP without TLS is not recommended. All resource URIs in the sub-clauses below are defined relative to the above root URI. The content format JSON shall be supported. The JSON format i

43、s signalled by the content type “application/json“. This API supports additional application-related error information to be provided in the HTTP response when an error occurs. See clause 7.15 of ETSI GS MEC 009 3 for more information. Figure 7.2-1 illustrates the resource URI structure of this API.

44、 Figure 7.2-1: Resource URI structure of the UE Identity API. Table 7.2-1 provides an overview of the resources defined by the present document, and the applicable HTTP methods. Table 7.2-1: Resources and methods overview Resource name Resource URI HTTP method Meaning Individual UeIdentityTagInfo /a

45、ppInstanceId/ue_identity_tag_info GET Retrieve information about specific UeIdentityTagInfo PUT Register/De-register the information about specific UeIdentityTagInfo 7.3 Resource: individual UeIdentityTagInfo 7.3.1 Description This resource is used to represent the information of a single UE Identit

46、y tag resource, which follows the resource data type of “UeIdentityTagInfo“ as specified in clause 6.2.2. ETSI ETSI GS MEC 014 V1.1.1 (2018-02) 10 7.3.2 Resource definition Resource URI: apiRoot/ui/v1/appInstanceId/ue_identity_tag_info Resource URI Variables for this resource are defined in table 7.

47、3.2-1. Table 7.3.2-1: Resource URI Variables for resource “individual UeIdentityTagInfo“ Name Definition apiRoot See clause 7.2 appInstanceId Represents a mobile edge application instance 7.3.3 Resource Methods 7.3.3.1 GET This method retrieves information about a UeIdentityTagInfo resource. This me

48、thod shall comply with the URI query parameters, request and response data structures, and response codes, as specified in the tables 7.3.3.1-1 and 7.3.3.1-2. Table 7.3.3.1-1: URI query parameters supported by the GET method on this resource Name Data type Cardinality Remarks ueIdentityTag String 1N

49、 Represents one or more UEs Table 7.3.3.1-2: Data structures supported by the GET request/response on this resource Request body Data type Cardinality Remarks n/a Response body Data type Cardinality Response codes Remarks UeIdentityTagInfo 1 200 OK It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource. ProblemDetails 01 400 Bad Request It is used to indicate that incorrect parameters were passed to the request. In the returned Proble