This documentation is currently under development and subject to change. It reflects outcomes elaborated by 5G-MAG members. If you are interested in becoming a member of the 5G-MAG and actively participating in shaping this work, please contact the Project Office

Using CAMARA APIs: QoS Booking for Content Production & Contribution

Find more information about QoS Booking API.

Purpose

A user of a media application would like to request the assignment of a QoS Profile to a device for a given period of time and service area.

Workflow and Architecture

This is a high-level figure with the entities involing APIs and the devices involved:

General Workflow

The following steps are executed:

0

Pre-conditions

ASP

+

CSP

On-boarding of the ASP and Negotiation
-  Sign up and access credentials
-  Selection / Request for QoS Profiles

1

Before using the network

ASP

1.0a. Discovery of available and eligible QoS Profiles (optional)

ASP

1.1. Request of Creation of QoS Booking

2

During operation

ASP

2.1. Device establishes connection and uses the QoS Booking

ASP

2.2. Usage of API capabilities

3

Dismantling

ASP

3.1a. Deletion of QoS Booking

CSP

3.1b. Or the CSP simply tears the QoS Booking down

Step 0: Pre-conditions

• The API invoker needs to have signed up with the API provider.
• qosProfiles have already been defined and made available by the network operator.
• Names of such qosProfiles have been disclosed to the user so they can be used when invoking APIs.

Step 1: Before using the network

Details of the already arranged QoS Profile can be retrieve with GET /qos-profiles/{name}, using the QoS Profiles API.

1.1 Requests creation of QoS Booking

With POST /device-qos-bookings passing the qosProfile, applicationServer, applicationServerPorts, device object, devicePorts, startTime, duration, serviceArea.

Step 2: During operation

2.1 Device establishes connection

2.3 Usage of API capabilities

A series of operations to delete the QoS session or extending its duration are available:

POST /retrieve-device-qos-bookings - Retrieve device QoS Bookings

GET /device-qos-bookings/{bookingId} - Obtain device QoS Booking details

Step 3: Dismantling

When reaching the duration the QoS Booking may be teared down. A greceful way of tearing down will delete the QoS session by id.

DELETE /device-qos-bookings/{bookingId} deletes the QoS Booking

---

5G-MAG’s Self-Assessment

• The QoS Booking APIs can be invoked before the actual usage of the network starts to ensure that the requested capabilities are “reserved” for the specific area, time window and device.
• During the event a device will have access to the QoS Booking.
• This API may be suitable for a setup where a single device requires access to network resources (e.g. MoJo). However this is impractical for a Media Production setup with multiple devices as not all of them may be running at the same time. Making different QoS bookings for each of them while not requiring access to network resources concurrently may result in inneficiencies.

Potential improvements:

• It is unclear how to associate devices to make use of the resources. As it stands, the device is granted the booking as soon as connected to the network under the service area and for the specified duration.
• It is unclear how to update the booking. In the event that a device would need to be exchanged, deleting and creating a new booking may lead to loosing the ability to reserve resources during operation.