|
GROUP SPECIFICATION
Multi-access Edge Computing (MEC);
UE application interface
Disclaimer
The present document has been produced and approved by the Multi-access Edge Computing (MEC) ETSI Industry
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.
---------------------- Page: 1 ----------------------
2 ETSI GS MEC 016 V2.1.1 (2019-04)
Reference
RGS/MEC-0016v211UEAppInterface
Keywords
API, MEC
ETSI
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 enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
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 between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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
If you find errors in the present document, please send your comment to one of the following services:
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 of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2019.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS MEC 016 V2.1.1 (2019-04)
Contents
Intellectual Property Rights . 5
Foreword . 5
Modal verbs terminology . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 7
3 Definition of terms, symbols and abbreviations . 7
3.1 Terms . 7
3.2 Symbols . 7
3.3 Abbreviations . 7
4 Overview . 7
5 Description of the service (informative). 8
5.1 Sequence diagrams . 8
5.1.1 Introduction. 8
5.1.2 User application look-up . 8
5.1.3 Application context create . 8
5.1.4 Application context delete . 9
5.1.5 Application context update . 9
5.1.6 Receiving notification events . 10
6 Data model . 11
6.1 Introduction . 11
6.2 Resource data types . 11
6.2.1 Introduction. 11
6.2.2 Type: ApplicationList . 11
6.2.3 Type: AppContext . 12
6.3 Subscription data types . 13
6.4 Notification data types . 13
6.4.1 Introduction. 13
6.4.2 Type: NotificationEvent . 13
6.5 Referenced structured data types . 13
7 API definition . 13
7.1 Introduction . 13
7.2 Global definitions and resource structure . 14
7.3 Resource: meAppList . 14
7.3.1 Description . 14
7.3.2 Resource definition . 14
7.3.3 Resource Methods . 15
7.3.3.1 GET . 15
7.3.3.2 PUT . 16
7.3.3.3 PATCH . 16
7.3.3.4 POST . 16
7.3.3.5 DELETE . 16
7.4 Resource: all ueAppContexts . 16
7.4.1 Description . 16
7.4.2 Resource definition . 16
7.4.3 Resource Methods . 16
7.4.3.1 GET . 16
7.4.3.2 PUT . 16
7.4.3.3 PATCH . 16
7.4.3.4 POST . 16
7.4.3.5 DELETE . 17
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS MEC 016 V2.1.1 (2019-04)
7.5 Resource: individual ueAppContext . 17
7.5.1 Description . 17
7.5.2 Resource definition . 17
7.5.3 Resource Methods . 18
7.5.3.1 GET . 18
7.5.3.2 PUT . 18
7.5.3.3 PATCH . 19
7.5.3.4 POST . 19
7.5.3.5 DELETE . 19
8 Authentication, authorization and access control . 19
8.1 Introduction . 19
8.2 Description . 20
Annex A (informative): Complementary material for API utilization . 21
History . 22
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS MEC 016 V2.1.1 (2019-04)
Intellectual Property Rights
Essential 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); Essential, 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 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 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 endorsement 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) Multi-access Edge
Computing (MEC).
Modal verbs terminology
In the present document "shall", "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 in direct citation.
ETSI
---------------------- Page: 5 ----------------------
6 ETSI GS MEC 016 V2.1.1 (2019-04)
1 Scope
The present document contains the specification for the lifecycle management of user applications over the UE
application interface. This interface is over the Mx2 reference point between the device application in the UE and the
User Application LifeCycle Management Proxy (UALCMP) in the MEC system.
The present document covers the following lifecycle management operations: user application look-up, request for the
user application instantiation, and the request for the user application termination. In addition, a mechanism is specified
for the exchange of lifecycle management related information between the MEC system and the UE application.
The intended key audience of the present document are the application developers for the MEC system, since the UE
application interface provides them with a method to instantiate their applications.
NOTE: User application mobility related lifecycle management operations are not covered by the present
document.
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 specific 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/.
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 010-2: "Mobile Edge Computing (MEC); Mobile Edge Management; Part 2:
Application lifecycle, rules and requirements management".
[2] IETF RFC 2818: "HTTP Over TLS".
NOTE: Available at https://tools.ietf.org/html/rfc2818.
[3] IETF RFC 8446: "The Transport Layer Security (TLS) Protocol Version 1.3".
NOTE: Available at https://tools.ietf.org/html/rfc8446.
[4] ETSI GS MEC 009: "Multi-access Edge Computing (MEC); General principles for MEC Service
APIs".
[5] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
NOTE: Available at https://tools.ietf.org/html/rfc6749.
[6] IETF RFC 6750: "The OAuth 2.0 Authorization Framework: Bearer Token Usage".
NOTE: Available at https://tools.ietf.org/html/rfc6750.
ETSI
---------------------- Page: 6 ----------------------
7 ETSI GS MEC 016 V2.1.1 (2019-04)
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. For 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 for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] ETSI GS MEC 001: "Multi-access Edge Computing (MEC); Terminology".
[i.2] ETSI GS MEC 002: "Multi-access Edge Computing (MEC); Phase 2: Use Cases and
Requirements".
[i.3] OpenAPI Specification.
NOTE: Available at https://github.com/OAI/OpenAPI-Specification.
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the terms given in ETSI GS MEC 001 [i.1] and the following apply:
user application lifecycle management proxy: system level functional element that allows specific and authorized
requests from the device application for the user application lifecycle management
3.2 Symbols
Void.
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI GS MEC 001 [i.1] and the following apply:
AA Authentication and Authorization
API Application Programming Interface
OSS Operations Support System
TLS Transport Layer Security
UALCMP User Application LifeCycle Management Proxy
UE User Equipment
URI Uniform Resource Identifier
4 Overview
The present document specifies the API for the UE application interface to support the corresponding requirements
defined for the Multi-access Edge Computing in ETSI GS MEC 002 [i.2].
Clause 5 describes how the UE application interface can be used by the device application and by the MEC system. It
describes the information flows for the procedures over the UE application interface.
The information that is exchanged over the UE application interface is described in clause 6, providing detailed
description of all information elements available on that interface.
ETSI
---------------------- Page: 7 ----------------------
8 ETSI GS MEC 016 V2.1.1 (2019-04)
Clause 7 describes the actual API of the UE application interface, providing detailed information how the information
elements map into the RESTful API design of the interface.
Clause 8 describes the authentication, authorization and access control for the UE application interface.
5 Description of the service (informative)
5.1 Sequence diagrams
5.1.1 Introduction
The following clauses describe how the device application interacts with the UALCMP over the UE application
interface. The sequence diagrams that are relevant for the UE application interface are presented.
The device application presents the access token to the UALCMP with every request in order to assert that it is allowed
to access the resource with the particular method it invokes. The access token is included in the "Authorization" request
header field as a bearer token according to IETF RFC 6750 [6].
5.1.2 User application look-up
The user application look-up is the procedure for requesting the list of available user applications in the MEC system to
the requesting device application. The user application look-up procedure is illustrated in figure 5.1.2-1.
Figure 5.1.2-1: User application look-up
1) The device application submits the GET request to the UALCMP. The UALCMP authorizes the request from
device application. The MEC system retrieves the list of user applications available to the requesting device
application.
2) The UALCMP returns the 200 OK response to the device application, with the message body containing the
data structure for the list of available user applications.
5.1.3 Application context create
The application context create is the procedure to request either to join with an available user application or to
instantiate a new user application. The application context create procedure is illustrated in figure 5.1.3-1.
As part of the user application instantiation, the MEC system will create an associated application context that the MEC
system maintains for the lifetime of the user application. The application context contains information specific to the
application instance such as its unique identifier within the MEC system and the address (URI) provided for clients that
are external to the MEC system to interact with the user application.
ETSI
---------------------- Page: 8 ----------------------
9 ETSI GS MEC 016 V2.1.1 (2019-04)
Figure 5.1.3-1: Application context create
1) The device application submits the POST request to the UALCMP. The message body contains the data
structure for the application context to be created.
2) The UALCMP authorizes the request from the device application. The request is forwarded to the OSS. The
OSS makes the decision on granting the context creation request. The MEC orchestrator triggers the creation
of the application context in the MEC system.
3) The UALCMP returns the 201 Created response to the device application with the message body containing
the data structure of the created application context, which includes the address (reference URI) provided for
clients that are external to the MEC system to interact with the user application. The response message header
contains the address of the resource relating to the application instance context created and maintained by the
MEC system.
5.1.4 Application context delete
The application context delete is a procedure in which the device application requests the deletion of the application
context. The application context delete procedure is illustrated in figure 5.1.4-1.
Figure 5.1.4-1: Application context delete
1) The device application submits the DELETE request to the UALCMP for the application context to be deleted.
2) The UALCMP authorizes the request from device application. The request is forwarded to the OSS. The OSS
makes the decision on granting the deletion. The MEC orchestrator triggers the deletion of the application
context, including deletion of the resource maintained by the MEC system that represents it.
3) The UALCMP returns "204 No content" response.
5.1.5 Application context update
The UALCMP is provided with an update of the application context. The procedure is illustrated in figure 5.1.5-1.
ETSI
---------------------- Page: 9 ----------------------
10 ETSI GS MEC 016 V2.1.1 (2019-04)
Figure 5.1.5-1: Application context update
1) The device application updates a specific application context by sending a PUT request to the resource within
the MEC system that represents it, with the message body containing the modified data structure of
AppContext in which only the callback reference may be updated.
2) The UALCMP returns a "204 No Content" response.
5.1.6 Receiving notification events
Figure 5.1.6-1 presents the scenario where the UALCMP sends notification events to the device application.
Figure 5.1.6-1: Flow of receiving notification events
Receiving notification events, as illustrated in figure 5.1.6-1, consists of the following steps:
1) The UALCMP sends a POST message to the callback reference address provided by the device application as
part of application context creation, with the message body containing the notification event, indicating for
instance a modification to the address of the user application.
2) The device application sends a "204 No Content" response to the UALCMP.
ETSI
---------------------- Page: 10 ----------------------
11 ETSI GS MEC 016 V2.1.1 (2019-04)
6 Data model
6.1 Introduction
The following clauses provide the description of the data model.
6.2 Resource data types
6.2.1 Introduction
This clause defines data structures to be used in resource representations.
6.2.2 Type: ApplicationList
This type represents the information on available applications. The device application can acquire this information by
user application look-up procedure described in clause 5.1.2.
The elements of the ApplicationList shall follow the notations provided in table 6.2.2-1.
Table 6.2.2-1: Definition of type ApplicationList
Attribute name Data type Cardinality Description
appList Array (Structure 0.N List of user applications available to the device application.
(inlined)) As defined below.
>appInfo Structure (inlined) 1
>>appDId String 1 Identifier of this MEC application descriptor. It is equivalent
to the appDId defined in clause 6.2.1.2 of ETSI
GS MEC 010-2 [1]. This attribute shall be globally unique.
>>appName String 1 Name of the MEC application.
The length of the value shall not exceed 32 characters.
>>appProvider String 1 Provider of the MEC application.
The length of the value shall not exceed 32 characters.
>>appSoftVersion String 1 Software version of the MEC application.
The length of the value shall not exceed 32 characters.
>>appDVersion String 1 Identifies the version of the application descriptor. It is
equivalent to the appDVersion defined in clause 6.2.1.2 of
ETSI GS MEC 010-2 [1].
>>appDescription String 1 Human readable description of the MEC application (see
note 2).
>>appCharcs Structure (inlined) 0.1 Characteristics of the application.
As defined below.
The application characteristics relate to the system
resources consumed by the application. device application
can use this information e.g. for estimating the cost of use
of the application or for the expected user experience.
>>>memory uint32 0.1 The maximum size in Mbytes of the memory resource
expected to be used by the MEC application instance in
the MEC system.
>>>storage uint32 0.1 The maximum size in Mbytes of the storage resource
expected to be used by the MEC application instance in
the MEC system.
>>>latency uint32 0.1 The target round trip time in milliseconds supported by the
MEC system for the MEC application instance.
>>>bandwidth uint32 0.1 The required connection bandwidth in kbit/s for the use of
the MEC application instance.
>>>serviceCont Enum 0.1 Required service continuity mode for this application.
Permitted values:
0 = SERVICE_CONTINUITY_NOT_REQUIRED.
1 = SERVICE_CONTINUITY_REQUIRED.
>vendorSpecificExt Structure (inlined) 0.1 Extension for vendor specific information (see note 1).
ETSI
---------------------- Page: 11 ----------------------
12 ETSI GS MEC 016 V2.1.1 (2019-04)
Attribute name Data type Cardinality Description
>>vendorId String 1 Vendor identifier.
The length of the value shall not exceed 32 characters.
The rest of the structure of vendor specific extension is not
defined.
NOTE 1: The vendor specific extension allows submitting information on the application lists that have been made
available to the device application of the corresponding vendor.
NOTE 2: The language support may be limited The length of the value shall not exceed 128 characters.
6.2.3 Type: AppContext
This type represents the information on application context created by the MEC system.
The elements of the AppContext shall follow the notations provided in table 6.2.3-1.
Table 6.2.3-1: Definition of type AppContext
Attribute name Data type Cardinality Description
contextId String 0.1 Uniquely identifies the application context in the MEC
system.
Assigned by the MEC system and shall be present
other than in a create request.
The length of the value shall not exceed 32
characters.
associateUeAppId String 1 Uniquely identifies the device application.
The length of the va
...