ETSI GS MEC 015 V1.1.1 (2017-10)

Mobile Edge Computing (MEC); Bandwidth Management API

DGS/MEC-0015BandMngtAPI

General Information

• Status: Published
• Publication Date: 10-Oct-2017
• Technical Committee: MEC - Multi-access Edge Computing
• Current Stage: 12 - Completion
• Due Date: 25-Oct-2017
• Completion Date: 11-Oct-2017

Standards Content (Sample)

ETSI GS MEC 015 V1.1.1 (2017-10)






GROUP SPECIFICATION
Mobile Edge Computing (MEC);
Bandwidth Management 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 necessarily represent the views of the entire ETSI membership.

---------------------- Page: 1 ----------------------
2 ETSI GS MEC 015 V1.1.1 (2017-10)



Reference
DGS/MEC-0015BandMngtAPI
Keywords
API, bandwidth, management, MEC
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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:
http://www.etsi.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 difference 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 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/CommiteeSupportStaff.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 of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© ETSI 2017.
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
3GPP and LTE™ are trademarks of ETSI registered for the benefit of 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

---------------------- Page: 2 ----------------------
3 ETSI GS MEC 015 V1.1.1 (2017-10)
Contents
Intellectual Property Rights . 4
Foreword . 4
Modal verbs terminology . 4
1 Scope . 5
2 References . 5
2.1 Normative references . 5
2.2 Informative references . 5
3 Definitions . 6
4 Abbreviations . 6
5 Overview . 6
6 Description of the service (informative). 7
6.1 Introduction . 7
6.2 Sequence diagrams . 7
6.2.1 General . 7
6.2.2 Register to Bandwidth Management Service . 7
6.2.3 Unregister from Bandwidth Management Service . 8
6.2.4 Update requested bandwidth requirements on Bandwidth Management Service . 8
6.2.5 Get configured bandwidth allocation from Bandwidth Management Service . 9
7 Data Model . 9
7.1 Introduction . 9
7.2 Resource data types . 10
7.2.1 Introduction. 10
7.2.2 Type: BwInfo . 10
7.2.3 Type: BwInfoDeltas . 10
8 API definition . 11
8.1 Introduction . 11
8.2 Global definitions and resource structure . 11
8.3 Resource: individual bandwidthAllocation . 12
8.3.1 Description . 12
8.3.2 Resource definition . 12
8.3.3 Resource Methods . 12
8.3.3.1 GET . 12
8.3.3.2 PUT . 13
8.3.3.3 PATCH . 14
8.3.3.4 POST . 15
8.3.3.5 DELETE . 15
8.4 Resource: a list of bandwidthAllocations . 16
8.4.1 Description . 16
8.4.2 Resource definition . 16
8.4.3 Resource Methods . 16
8.4.3.1 GET . 16
8.4.3.2 PUT . 17
8.4.3.3 PATCH . 17
8.4.3.4 POST . 17
8.4.3.5 DELETE . 18
Annex A (informative): Complementary material for API utilization . 19
History . 20


ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS MEC 015 V1.1.1 (2017-10)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to the present document 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) Mobile 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: 4 ----------------------
5 ETSI GS MEC 015 V1.1.1 (2017-10)
1 Scope
The present document focuses on the Bandwidth Management mobile edge service. It describes the related application
policy information including authorization and access control, information flows, required information and service
aggregation patterns. The present document specifies the necessary API with the data model and data format.
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 001: "Mobile Edge Computing (MEC) Terminology ".
[2] IETF RFC 2818: "HTTP Over TLS".
NOTE: Available at https://tools.ietf.org/html/rfc2818.
[3] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2".
NOTE: Available at https://tools.ietf.org/html/rfc5246.
[4] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
NOTE: Available at https://tools.ietf.org/html/rfc6749.
[5] IETF RFC 6750: "The OAuth 2.0 Authorization Framework: Bearer Token Usage".
NOTE: Available at https://tools.ietf.org/html/rfc6750.
[6] ETSI GS MEC 009: "Mobile Edge Computing (MEC); General principles for Mobile Edge
Service APIs".
[7] IETF RFC 7396: "JSON Merge Patch".
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 002: "Mobile Edge Computing (MEC); Technical Requirements".
ETSI

---------------------- Page: 5 ----------------------
6 ETSI GS MEC 015 V1.1.1 (2017-10)
[i.2] OpenAPI Specification, Version 2.0, September 8, 2014.
NOTE: Available at https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md.
3 Definitions
For the purposes of the present document, the terms and definitions given in ETSI GS MEC 001 [1] apply.
4 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
BW Bandwidth
BWM Bandwidth Management
BWMS Bandwidth Management Service
CDN Content Delivery Network
HTTP Hypertext Transfer Protocol
HTTPS Hypertext Transfer Protocol Secure
IETF Internet Engineering Task Force
JSON Javascript Object Notation
ME Mobile Edge
OAI Open API Initiative
RAN Radio Access Network
REST Representational State Transfer
RFC Request For Comments
RTT Round Trip Time
TLS Transport Layer Security
URI Uniform Resource Indicator
UTC Coordinated Universal Time
5 Overview
The present document specifies the Bandwidth Management service (BWMS) API to support the requirements defined
for Mobile Edge Computing in ETSI GS MEC 002 [i.1]. Clause 6 introduces how BWMS can be used by the mobile
edge applications and by the mobile edge platform. It describes the information flows used for BWMS.
The information that can be exchanged over the Bandwidth Management (BWM) API is described in clause 7 which
provides detailed description on all information elements that are used for BWMS.
Clause 8 describes the actual BWM API providing detailed information how information elements are mapped into a
RESTful API design.
Figure 5-1 illustrates the mission of the BWMS, which may optionally run as part of the platform or as an application.
Different applications, whether managing a single instance or several sessions (for example CDN), may request specific
bandwidth requirements (bandwidth size, bandwidth priority, or both) for the whole application instance or different
bandwidth requirements per session. The BWMS may aggregate all the requests and act in a manner that will help
optimize the BW usage.
ETSI

---------------------- Page: 6 ----------------------
7 ETSI GS MEC 015 V1.1.1 (2017-10)

Figure 5-1: Bandwidth Management service description
6 Description of the service (informative)
6.1 Introduction
Different mobile edge applications running in parallel on the same mobile edge host may require specific static/dynamic
up/down bandwidth resources, including bandwidth size and bandwidth priority. In some cases different sessions
running in parallel on the same application may each have specific bandwidth requirements. In addition, sessions driven
by applications running from closer to end user (shorter RTT) may receive unfair advantage over session driven by
application running from distant locations (outside the RAN). As all these applications and application sessions are
competing over the same shared bandwidth resources, an optional central bandwidth resource allocator service may
exist on the mobile edge platform.
The specific session or mobile edge application will be identified using a set of filters within the resource request.
6.2 Sequence diagrams
6.2.1 General
The following clauses describe how mobile edge applications can use BWMS to update/receive bandwidth information
to/from the ME platform. The sequence diagrams that are relevant for BWMS are presented.
The BWM API enables all registered applications to statically and/or dynamically register for specific bandwidth
allocation per session/application.
This specification of BWM API contains the HTTP protocol bindings for bandwidth management functionality using
the REST architectural style.
6.2.2 Register to Bandwidth Management Service
Figure 6.2.2-1 shows a scenario where a Mobile Edge Application registers to BWMS.
ETSI

---------------------- Page: 7 ----------------------
8 ETSI GS MEC 015 V1.1.1 (2017-10)

Figure 6.2.2-1: Flow of Mobile Edge Application registration to BWMS
Mobile Edge Application instance registration to BWMS, as illustrated in figure 6.2.2-1, consists of the following steps:
1) Mobile edge application instance sends a request to register to the BWMS with the requested bandwidth
requirements (bandwidth size/priority).
2) BWMS responds with a registration and initialization approval.
6.2.3 Unregister from Bandwidth Management Service
Figure 6.2.3-1 shows a scenario where a Mobile Edge Application Instance unregisters from BWMS.

Figure 6.2.3-1: Flow of Mobile Edge Application unregistering BW allocation from BWMS
Mobile Edge Application Instance unregistering from BWMS , as illustrated in figure 6.2.3-1, consists of the following
steps:
1) Mobile Edge Application Instance sends an unregister request to BWMS.
2) BWMS responds with an unregistration approval.
6.2.4 Update requested bandwidth requirements on Bandwidth
Management Service
Figure 6.2.4-1 shows a scenario where a Mobile Edge Application Instance updates its requested bandwidth
requirements on the BWMS.
ETSI

---------------------- Page: 8 ----------------------
9 ETSI GS MEC 015 V1.1.1 (2017-10)

Figure 6.2.4-1: Flow of Mobile Edge application updating its requested
bandwidth requirements on BWMS
Mobile edge application instance up
...