R3 - API Documentation
- 1 Introduction
- 2 API Definitions
- 2.1 Application Life Cycle Management
- 2.1.1 Get a list of applications
- 2.1.2 Create a new application
- 2.1.3 Get an application
- 2.1.4 Update an existing application
- 2.1.5 Delete an existing application
- 2.1.6 Get a list of applications on a node
- 2.1.7 Deploy an application to a node
- 2.1.8 Get an application on a node
- 2.1.9 Update an application on a node
- 2.1.10 Delete an application on a node
- 2.2 Edge Application API
- 2.2.1 Connection Establishment
- 2.2.2 Publish Notification
- 2.2.3 Service Discovery
- 2.2.4 Service Deactivation
- 2.2.5 Service Activation
- 2.2.6 List Subscriptions
- 2.2.7 Mass Unsubscription
- 2.2.8 Service Unsubscription
- 2.2.9 Service Subscription
- 2.2.10 Service Unsubscription
- 2.2.11 Service Subscription
- 2.1 Application Life Cycle Management
Introduction
5G MEC BP inherits some APIs implemented by OpenNESS, which can be used in the so-called on-premises deployment where kubernetes is not available.
In this release, APIs exposed include those related to :
Application Life Cycle Management
Edge Application API.
API Definitions
Application Life Cycle Management
These API provides an abstraction layer for an operations admin, enabling them to configure and manage the lifecycle of applications.
Get a list of applications
1.API Name | Get a list of applications | Type | GET |
Description | The GET method is used to get a list of applications from the controller | ||
Resource URI | /apps | ||
Parameters-None | |||
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
apps | 1 | json | Application Info |
Create a new application
2.API Name | Create a new application | Type | POST |
Description | The POST method is used to create a new application on the controller | ||
Resource URI | /apps | ||
Parameters-None | |||
Request Body | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 201 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the node |
Get an application
3.API Name | Get an application | Type | GET |
Description | The GET method is used to get an application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 404 | ||
App ID not found | |||
Update an existing application
4.API Name | Update an existing application | Type | PATCH |
Description | The PATCH method is used to update an existing application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 200 | ||
Application was updated | |||
Response Codes | 404 | ||
App ID not found | |||
Delete an existing application
5.API Name | Delete an existing application | Type | DELETE |
Description | The DELETE method is used to delete an existing application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 204 | ||
Application was deleted | |||
Response Codes | 404 | ||
App ID not found | |||
Get a list of applications on a node
6.API Name | Get a list of applications on a node | Type | GET |
Description | The GET method is used to get a list of applications on a node from the controller | ||
Resource URI | /nodes/{node_id}/apps | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
apps | 1 | json | Application Info |
Response Codes | 404 | ||
Node ID not found | |||
Deploy an application to a node
7.API Name | Deploy an application to a node | Type | POST |
Description | The POST method is used to deploys an application to a node from the controller | ||
Resource URI | /nodes/{node_id}/apps | ||