\
\
\
\
\
-#### QoD Create Latency QoS Session Operation +#### QoD Create QoS Session Operation -| **Create Latency QoS Session** | +| **Create QoD Session** | | -------------------------- | -| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**protocolIn:** The used transport protocol for the uplink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**protocolOut :** The used transport protocol for the downlink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**qos:** Qualifier for the requested latency profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**duration:** Session duration in seconds.
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**protocolIn:** The used transport protocol for the uplink.
**protocolOut:** The used transport protocol for the downlink.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** | +| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**protocolIn:** The used transport protocol for the uplink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**protocolOut :** The used transport protocol for the downlink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**qos:** Qualifier for the requested latency/throughput profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**duration:** Session duration in seconds.
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**protocolIn:** The used transport protocol for the uplink.
**protocolOut:** The used transport protocol for the downlink.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** |
#### QoD Query for Latency QoS Session @@ -99,7 +102,7 @@ Following table defines API endpoints of exposed REST based for QoD latency mana | ---------------------------- | | **HTTP Request**
DELETE\
**Query Parameters**
No query parameters are defined.
**Path Parameters**
sessionId: Session ID that need to terminated.
**Request Body Parameters**
No request body parameters are defined.
**Response**
**204:** Session deleted
**401:** Un-authorized, missing or incorrect authentication.
**404:** Session not found | -### 4.3 Errors +### 4.4 Errors Since CAMARA QoD API is based on REST design principles and blueprints, well defined HTTP status codes and families specified by community are followed [4]. @@ -119,11 +122,11 @@ Following table provides an overview of common error names, codes and messages a | 8 | Session with same parameters already exists | 409 | "Found session \
Snippet 1, elaborates REST based API call with "*curl"* to create a QoS session for sample streaming service with following parameters: @@ -142,15 +145,15 @@ Snippet 2, elaborates sample QoS notification "SESSION\_TERMINATION" message dis | ------------------------------------------ | | {
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "event": "SESSION\_TERMINATED"
} | -### 4.6 FAQ's +### 4.7 FAQ's (FAQs will be added in a later version of the documentation) -### 4.7 Terms +### 4.8 Terms N/A -### 4.8 Release Notes +### 4.9 Release Notes N/A From 5a44d51473d3814f319f109dbef057dc839641db Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Tue, 15 Nov 2022 12:56:41 +0100 Subject: [PATCH 02/38] Add files via upload --- .../API_documentation/resources/QoD_details.PNG | Bin 0 -> 28084 bytes .../resources/QoD_overview.PNG | Bin 0 -> 15142 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 documentation/API_documentation/resources/QoD_details.PNG create mode 100644 documentation/API_documentation/resources/QoD_overview.PNG diff --git a/documentation/API_documentation/resources/QoD_details.PNG b/documentation/API_documentation/resources/QoD_details.PNG new file mode 100644 index 0000000000000000000000000000000000000000..0547d67fc2658a60c935f5d9af2718765770c750 GIT binary patch literal 28084 zcmce;1z40_+ct_Kf*=jjAcC|Ys5C=&4vln)N=Y|JcSs0G4=qTkbV?6MiZm!8T|@U? zgFesqyzhR$e}DVm$G_(|IADgEx!1bywXW;D&hxzPP!%O
DnVYhBXOfIe$$_LYBWZH?MFk~h1iKOp
ze|S?w$`i;VcTDQQ%W079o=vqJbRHrFQeaY(YL%OKQkf;jblaJWaTuhWH|(rCmIP1z
zRC#HWtSKh(IqMO^%NJrYZu~5zHjDK?e&SYs>y!VoE%-uzUFWKVzl_jcNIfoeN%s;q
zlL!Aj3H&#%*?)UZ|2JHj-)lxoFi9^}J
+
## 2\. Quick Start
@@ -18,7 +18,7 @@ The deletion of a requested session can be triggered by the user or can be trigg
Before starting to use the API, the developer needs to know about the below specified details:
**Base-URL**
-The RESTful Stable Throughput API endpoint, for example [**https://telekom-api.developer.telekom.com/5g-qod**](https://telekom-api.developer.telekom.com/5g-qod)
+The RESTful QoD API endpoint
**Authentication**
Configure security access keys such as OAuth 2.0 client credentials to be used by Client applications which will invoke the QoD API.
@@ -29,6 +29,9 @@ Define latency or throughput requirements of the application and identify QoS pr
**App-Flow**
Describes the precise flow the developer wants to prioritize and have stable latency or throughput for. This flow is described using source and destination IP addresses and ports/port-ranges.
+**Duration**
+Define the number of seconds for which the QoD session should be created. This parameter is optional and if not specified, the session is either deleted on user request or if default expiration limit has been reached (24 hours in reference implementation).
+
**Notification URL and token**
Developers have a chance to specify callback URL on which notifications (eg. session termination) regarding the session can be received from the service provider. This is an optional parameter.
@@ -53,18 +56,19 @@ Based on the API, QoS sessions can be created, queried, and deleted. Once an off
* A specified App-Flow is prioritized to ensure stable latency or throughput for that flow
* The prioritized App-Flow is described by providing information such as source & destination IP address and port/port-ranges
+* The developer can optionally specify the duration for which they need the prioritized App-flow
* Stable latency or throughput is requested by selecting from the list of QoS profiles made available by the service provider (e.g. QOS_E) to map latency requirements
* The developer can optionally also specify callback URL on which notifications for the session can be sent
Following diagram shows the interaction between different components
-
+
The below table shows sample QoS profiles and are subject to service provider customizations.
This sample is taken from the agreed sample (example) set from the Camara-project [2].
-| **QoD latency profile** | **Details** |
+| **QoD profile** | **Details** |
| ------------------- | ------- |
| QOS\_E | Enhanced communication class with with stable latency under congestion (e.g. throughput up-to 2Mbps) |
| QOS\_S | Small class of throughput profile - for example DL (Downlink) up-to 10Mbps |
@@ -86,19 +90,19 @@ Following table defines API endpoints of exposed REST based for QoD management o
| **Create QoD Session** |
| -------------------------- |
-| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**protocolIn:** The used transport protocol for the uplink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**protocolOut :** The used transport protocol for the downlink.
TCP - TCP protocol
UDP - UDP protocol
ANY - all protocols
**qos:** Qualifier for the requested latency/throughput profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**duration:** Session duration in seconds.
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**protocolIn:** The used transport protocol for the uplink.
**protocolOut:** The used transport protocol for the downlink.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** |
+| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**qos:** Qualifier for the requested latency/throughput profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** |
-#### QoD Query for Latency QoS Session
+#### QoD Query for QoS Session
-| **Quering QoS Session Latency information** |
+| **Quering QoS Session information** |
| --------------------------------------- |
-| **HTTP Request**
GET\
**Query Parameters**
No query parameters are defined.
**Path Parameters**
sessionId: Session id that was obtained from the Create QoS Session operation.
**Request Body Parameters**
No request body parameters are defined.
**Response**
**200: Session information returned.**
Response body:
**duration:** Session duration in seconds.
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**protocolIn:** The used transport protocol for the uplink.
**protocolOut:** The used transport protocol for the downlink.
**qos:** Qualifier of the requested Latency profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
**startedAt:** Timestamp of session start in seconds since unix epoch.
**expiresAt:** Timestamp of session expiration if the session was not deleted in seconds since unix epoch.
**401:** Un-authorised, missing or incorrect authentication.
**404:** Session not found.
**503:** Service temporarily unavailable. |
+| **HTTP Request**
GET\
**Query Parameters**
No query parameters are defined.
**Path Parameters**
sessionId: Session id that was obtained from the Create QoS Session operation.
**Request Body Parameters**
No request body parameters are defined.
**Response**
**200: Session information returned.**
Response body:
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**qos:** Qualifier of the requested Latency profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
**startedAt:** Timestamp of session start in seconds since unix epoch.
**expiresAt:** Timestamp of session expiration if the session was not deleted in seconds since unix epoch.
**401:** Un-authorised, missing or incorrect authentication.
**404:** Session not found.
**503:** Service temporarily unavailable. |
-#### QoD Delete Latency QoS Session
+#### QoD Delete QoS Session
-| **Deleting QoS Latency session** |
+| **Deleting QoS session** |
| ---------------------------- |
| **HTTP Request**
DELETE\
**Query Parameters**
No query parameters are defined.
**Path Parameters**
sessionId: Session ID that need to terminated.
**Request Body Parameters**
No request body parameters are defined.
**Response**
**204:** Session deleted
**401:** Un-authorized, missing or incorrect authentication.
**404:** Session not found |
@@ -112,15 +116,18 @@ Following table provides an overview of common error names, codes and messages a
| No | Error Name | Error Code | Error Message |
| --- | ---------- | ---------- | ------------- |
-| 1 | Invalid port(s) | 400 | "Ports specification not valid |
-| 2 | Invalid protocol | 400 | "Validation failed for parameter: protocol" |
-| 3 | Invalid QoS profile | 400 | "Validation failed for parameter: QoS-profile" |
-| 4 | Invalid IP address (format) | 400 | "Validation failed for parameter: IP-addr" |
-| 5 | Invalid duration | 400 | "Validation failed for parameter: Session duration" |
-| 6 | Unauthorized | 401 | "Un-authorized to invoke operation" |
-| 7 | Forbidden | 403 | "Forbidden to invoke operation" |
-| 8 | Session with same parameters already exists | 409 | "Found session \
Snippet 1, elaborates REST based API call with "*curl"* to create a QoS session for sample streaming service with following parameters:
-* Latency QoS session with 1H duration and QoS-profile "LOW\_Latency" mapping,
-* App-Flow is specified for UDP protocol with UE-Terminal IP address (ueAddr=10.0.0.1), Application server network (asAddr=54.204.25.0/28) and Port number (asPorts=33001).
+* Latency QoS session with QoS-profile "QOS_E" mapping,
+* App-Flow is specified for UE-Terminal IP address (ueAddr=10.0.0.1), Application server network (asAddr=54.204.25.0/28) and Port number (asPorts=33001).
Please note, the credentials for API authentication purposes need to be adjusted based on target security system configuration.
-| Snippet 1. Create QoS session to manage latency |
+| Snippet 1. Create QoS session |
| ----------------------------------------------- |
-| curl -X 'POST' `https://sample-base-url/qod-latency-api/v0/sessions`
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."
-d '{
"duration": 3600,
"ueAddr": "10.0.0.1",
"asAddr": "54.204.25.0/28",
"asPorts": "33001",
"protocolOut": "UDP",
"qos": "LOW\_Latency",
"notificationUri": `https://your-callback-server.com/notifications`,
"notificationAuthToken": "c8974e592c2fa383d4a3960714"
}' |
+| curl -X 'POST' `https://sample-base-url/qod-api/v0/sessions`
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."
-d '{
"ueAddr": "10.0.0.1",
"asAddr": "54.204.25.0/28",
"asPorts": "33001",
"qos": "QOS_E",
"notificationUri": `https://your-callback-server.com/notifications`,
"notificationAuthToken": "c8974e592c2fa383d4a3960714"
}' |
-Snippet 2, elaborates sample QoS notification "SESSION\_TERMINATION" message distributed from QoD backend to client callback function.
+Snippet 2, elaborates sample QoS notification "SESSION_TERMINATION" message distributed from QoD backend to client callback function.
| Snippet 2. Sample QoS session notification |
| ------------------------------------------ |
-| {
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "event": "SESSION\_TERMINATED"
} |
+| {
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "event": "SESSION_TERMINATED"
} |
### 4.7 FAQ's
From 769972267df3cdcf1059b326fa8cfaf6a2d2b61e Mon Sep 17 00:00:00 2001
From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com>
Date: Tue, 15 Nov 2022 17:17:13 +0100
Subject: [PATCH 04/38] Update QoD_API.md
---
documentation/API_documentation/QoD_API.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/API_documentation/QoD_API.md b/documentation/API_documentation/QoD_API.md
index fad3b36a75..5777e7d72c 100644
--- a/documentation/API_documentation/QoD_API.md
+++ b/documentation/API_documentation/QoD_API.md
@@ -70,10 +70,10 @@ This sample is taken from the agreed sample (example) set from the Camara-projec
| **QoD profile** | **Details** |
| ------------------- | ------- |
-| QOS\_E | Enhanced communication class with with stable latency under congestion (e.g. throughput up-to 2Mbps) |
-| QOS\_S | Small class of throughput profile - for example DL (Downlink) up-to 10Mbps |
-| QOS\_M | Medium class of throughput profile - for example DL (Downlink) up-to 30Mbps |
-| QOS\_L | Large class of throughput profile - for example DL (Downlink) up-to 100Mbps |
+| QOS_E | Enhanced communication class with with stable latency under congestion (e.g. throughput up-to 2Mbps) |
+| QOS_S | Small class of throughput profile - for example DL (Downlink) up-to 10Mbps |
+| QOS_M | Medium class of throughput profile - for example DL (Downlink) up-to 30Mbps |
+| QOS_L | Large class of throughput profile - for example DL (Downlink) up-to 100Mbps |
### 4.3 Endpoint Definitions
From 557243557853121398519f6f3199f4b7819f5cd4 Mon Sep 17 00:00:00 2001
From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com>
Date: Tue, 15 Nov 2022 19:35:57 +0100
Subject: [PATCH 05/38] Update QoD_API.md
---
documentation/API_documentation/QoD_API.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/API_documentation/QoD_API.md b/documentation/API_documentation/QoD_API.md
index 5777e7d72c..988ffa0946 100644
--- a/documentation/API_documentation/QoD_API.md
+++ b/documentation/API_documentation/QoD_API.md
@@ -90,7 +90,7 @@ Following table defines API endpoints of exposed REST based for QoD management o
| **Create QoD Session** |
| -------------------------- |
-| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**qos:** Qualifier for the requested latency/throughput profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** |
+| **HTTP Request**
POST \
**Query Parameters**
No query parameters are defined.
**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
**duration (optional)**: Session duration in seconds. Maximal value of 24 hours is used if not set.
**ueAddr:** The IPv4 address of the user equipment. It can contain a single IP address or a range, using a mask.
Format: \[/\
- address : an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
- address/mask : an IP number as above with a mask width of the form 1.2.3.4/24.
*In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.*
**asAddr:** The IPv4 address of the application server. It can contain a single IP address or a range, using a mask.
**uePort (optional):** A list of single ports or port ranges on the user equipment.
Ports may be specified as <\{port\|port\-port\}\[\,ports\[\,\.\.\.\]\]\>\.
The '-' notation specifies a range of ports (including boundaries).
Example: '5010-5020,5021,5022'
**asPort (optional):** A list of single ports or port ranges on the application server.
**qos:** Qualifier for the requested latency/throughput profile.
LOW\_LATENCY - to request the stable latency
**notificationUri (optional):** URI of the callback receiver. Allows asynchronous delivery of session related events .
Example: '[https://application-server.com/notifications](https://application-server.com/notifications)'
**notificationAuthToken (optional):** Authentification token for callback API.
Example: 'c8974e592c2fa383d4a3960714'
**Response**
**201: Session created**
Response body:
**duration:** Session duration in seconds.
**ueAddr:** The ipv4 address of the user equipment.
**asAddr:** The ipv4 address of the application server.
**uePort (optional):** The requested port(s) on the user equipment.
**asPort (optional):** The requested port(s) on the user equipment.
**qos:** Qualifier of the requested throughput profile.
**notificationUri (optional):** URI of the callback receiver.
**notificationAuthToken (optional):** Authentication token for callback API.
**id:** Session ID in UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
**startedAt:** Timestamp of session start, in seconds since unix epoch.
Example: 1639479600
**expiresAt**: Timestamp of session expiration if the session was not deleted, in seconds since unix epoch.
**400:** **Invalid input.**
**401:** **Un-authorized, missing or incorrect authentication.**
**405:** **Invalid input**
**500:** **Session not created**
**503:** **Service temporarily unavailable** |
#### QoD Query for QoS Session
From 0b6addd4e27344501f659a6d3dfd80b29d08ead2 Mon Sep 17 00:00:00 2001
From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com>
Date: Tue, 15 Nov 2022 19:39:10 +0100
Subject: [PATCH 06/38] Add files via upload
---
.../resources/QoD_overview.PNG | Bin 15142 -> 14712 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
diff --git a/documentation/API_documentation/resources/QoD_overview.PNG b/documentation/API_documentation/resources/QoD_overview.PNG
index 006bb2434b00516b3b53fb94fde9fda63ddb1442..b066939cf94a4e752dda4098e0096995c4b885a3 100644
GIT binary patch
literal 14712
zcmbWe2UL^Iw?68psGx#Wm0ktuB7$_3-a&c^pmd0U1VRreB2{|tQlv_d5+GEOUPBKM
zij)u_6zLuQulk+yJ9n+K?*Fd47J*5^JA3chd-m*^d7e-$4MpNxG`Fr?xk9Y0B&U7l
z%2hPb&LO-3{0_UA|NZA5S8YX^EARojRp1SQ?F;o6SFV&t-9CGL9e7XlR>{cq$`x|A
z->-jWZ5TbTToEN!mV2S=X||C;G(oQiyVOA#mt2gEk594O(&N&