Newer
Older
title: MEC Application Support API
description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI
contact:
email: cti_support@etsi.org
version: '2.1.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: http://127.0.0.1:8081/mec_app_support/v1
variables: {}
- url: https://127.0.0.1:8081/mec_app_support/v1
variables: {}
/applications/{appInstanceId}/traffic_rules:
- appTrafficRules
summary: ApplicationsTrafficRules_GET
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRules_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/TrafficRule'
description: ''
examples:
- - trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.168.2.0/24
- 192.168.3.0/24
dstAddress:
- 192.127.4.100/32
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
contentMediaType: application/json
examples:
TrafficRules:
value:
- trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.168.2.0/24
- 192.168.3.0/24
dstAddress:
- 192.127.4.100/32
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/traffic_rules/{trafficRuleId}:
- appTrafficRules
summary: ApplicationsTrafficRule_GET
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRule_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: trafficRuleId
in: path
description: Represents a traffic rule.
required: true
style: simple
schema:
type: string
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRule:
value:
trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.168.2.0/24
- 192.168.3.0/24
dstAddress:
- 192.127.4.100/32
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
- appTrafficRules
summary: ApplicationsTrafficRule_PUT
description: This method retrieves information about all the traffic rules associated with a MEC application instance.
operationId: ApplicationsTrafficRule_PUT
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: trafficRuleId
in: path
description: Represents a traffic rule.
required: true
style: simple
schema:
type: string
requestBody:
description: One or more updated attributes that are allowed to be changed
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
required: true
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRule:
value:
trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
priority: 1
trafficFilter:
- srcAddress:
- 192.168.2.0/24
- 192.168.3.0/24
dstAddress:
- 192.127.4.100/32
dstPort:
- '80'
action: FORWARD_DECAPSULATED
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/dns_rules:
- appDnsRules
summary: ApplicationsDnsRules_GET
description: This method retrieves information about all the DNS rules associated with a MEC application instance.
operationId: ApplicationsDnsRules_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/DnsRule'
description: ''
examples:
- - dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
- dnsRuleId: DnsRule2
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.4
ttl: 300
state: INACTIVE
contentMediaType: application/json
examples:
DnsRules:
value:
- dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
- dnsRuleId: DnsRule2
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.4
ttl: 300
state: INACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/dns_rules/{dnsRuleId}:
- appDnsRules
summary: ApplicationsDnsRule_GET
description: This method retrieves information about a DNS rule associated with a MEC application instance.
operationId: ApplicationsDnsRule_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: dnsRuleId
in: path
description: Represents a DNS rule.
required: true
style: simple
schema:
type: string
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRule:
value:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
- appDnsRules
summary: ApplicationsDnsRule_PUT
description: This method activates, de-activates or updates a traffic rule.
operationId: ApplicationsDnsRule_PUT
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: dnsRuleId
in: path
description: Represents a DNS rule.
required: true
style: simple
schema:
type: string
requestBody:
description: The updated state is included in the entity body of the request.
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
required: true
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRule:
value:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/subscriptions:
- appSubscriptions
summary: ApplicationsSubscriptions_GET
description: The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.
operationId: ApplicationsSubscriptions_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
description: Upon success, a response body containing the list of links to the requested subscriptions is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList'
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appSubscriptions
summary: ApplicationsSubscriptions_POST
description: The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.
operationId: ApplicationsSubscriptions_POST
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
requestBody:
description: Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
required: true
description: Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.
headers:
location:
description: The resource URI of the created resource
content:
text/plain:
schema:
type: string
description: The resource URI of the created resource
contentMediaType: text/plain
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/subscriptions/{subscriptionId}:
- appSubscriptions
summary: ApplicationsSubscription_GET
description: The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.
operationId: ApplicationsSubscription_GET
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: subscriptionId
in: path
description: Represents a subscription to the notifications from the MEC platform.
required: true
style: simple
schema:
type: string
description: Upon success, a response body containing the requested subscription is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
- appSubscriptions
summary: ApplicationsSubscription_DELETE
description: This method deletes a mecAppSuptApiSubscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
operationId: ApplicationsSubscription_DELETE
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
- name: subscriptionId
in: path
description: Represents a subscription to the notifications from the MEC platform.
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/confirm_termination:
- appConfirmTermination
summary: ApplicationsConfirmTermination_POST
description: This method is used to confirm the application level termination of an application instance.
operationId: ApplicationsConfirmTermination_POST
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationConfirmation'
required: false
description: Unauthorized. It is used when the client did not submit the appropriate credentials.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Too Many Requests. It is used when a rate limiter has triggered.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/applications/{appInstanceId}/confirm_ready:
- appConfirmReady
summary: ApplicationsConfirmReady_POST
description: 'This method may be used by the MEC application instance to notify the MEC platform that it is up and running. '
operationId: ApplicationsConfirmReady_POST
parameters:
- name: appInstanceId
in: path
description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppReadyConfirmation'
required: false
description: Unauthorized. It is used when the client did not submit the appropriate credentials.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Too Many Requests. It is used when a rate limiter has triggered.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/timing/timing_caps:
- timing
summary: TimingCaps_GET
description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
parameters: []
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimingCaps'
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/timing/current_time:
- timing
summary: TimingCurrentTime_GET
description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
parameters: []
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentTime'
'400':
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
'403':
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
Walter Featherstone
committed
components:
schemas:
const: READY
type: string
description: Indication about the MEC application instance.
examples:
- READY
description: This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.
- operationAction
type: object
properties:
operationAction:
$ref: '#/components/schemas/OperationActionType'
description: This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop.
title: AppTerminationNotification.Links
properties:
subscription:
$ref: '#/components/schemas/LinkType'
confirmTermination:
$ref: '#/components/schemas/LinkType.ConfirmTermination'
description: Object containing hyperlinks related to the resource.
Walter Featherstone
committed
AppTerminationNotification:
Walter Featherstone
committed
required:
- notificationType
- operationAction
- maxGracefulTimeout
- _links
type: object
Walter Featherstone
committed
properties:
notificationType:
type: string
description: Shall be set to AppTerminationNotification.
examples:
- AppTerminationNotification
operationAction:
$ref: '#/components/schemas/OperationActionType'
Walter Featherstone
committed
maxGracefulTimeout:
type: integer
description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
contentEncoding: int32
examples:
- 10
Walter Featherstone
committed
_links:
$ref: '#/components/schemas/AppTerminationNotification.Links'
description: This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.
Walter Featherstone
committed
AppTerminationNotificationSubscription:
title: AppTerminationNotificationSubscription
Walter Featherstone
committed
required:
- subscriptionType
- callbackReference
- _links
- appInstanceId
type: object
Walter Featherstone
committed
properties:
subscriptionType:
type: string
description: Shall be set to AppTerminationNotificationSubscription.
examples:
- AppTerminationNotificationSubscription
Walter Featherstone
committed
callbackReference:
type: string
description: URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response.
Walter Featherstone
committed
_links:
$ref: '#/components/schemas/Self'
appInstanceId:
type: string
description: It is used as the filtering criterion for the subscribed events.
examples:
- ID1
description: This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.
Walter Featherstone
committed
CurrentTime:
Walter Featherstone
committed
required:
- seconds
- nanoSeconds
- timeSourceStatus
type: object
Walter Featherstone
committed
properties:
seconds:
type: integer
description: The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
- 1577836800
Walter Featherstone
committed
nanoSeconds:
type: integer
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
- 0
Walter Featherstone
committed
timeSourceStatus:
$ref: '#/components/schemas/TimeSourceStatus'
description: This type represents the information provided by the MEC platform in response to the Get Platform Time Request message.
Walter Featherstone
committed
DestinationInterface.InterfaceType:
title: DestinationInterface.InterfaceType
Walter Featherstone
committed
enum:
Walter Featherstone
committed
type: string
description: Type of the interface
examples:
- TUNNEL
Walter Featherstone
committed
DestinationInterface:
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
interfaceType:
$ref: '#/components/schemas/DestinationInterface.InterfaceType'
tunnelInfo:
$ref: '#/components/schemas/TunnelInfo'
srcMacAddress:
type: string
description: Source address identifies the MAC address of the interface
examples:
- 02-00-00-00-00-00
Walter Featherstone
committed
dstMacAddress:
type: string
description: Source address identifies the MAC address of the interface
examples:
- 02-00-00-00-00-00
Walter Featherstone
committed
dstIpAddress:
type: string
description: IP address of the remote destination
examples:
- 192.0.2.0
description: This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided.
Walter Featherstone
committed
DnsRule.IpAddressType:
Walter Featherstone
committed
enum:
Walter Featherstone
committed
type: string
description: IP address type
examples:
- IP_V6
DnsRule.State:
title: DnsRule.State
Walter Featherstone
committed
enum:
- ACTIVE
- INACTIVE
type: string
description: DNS rule state. This attribute may be updated using HTTP PUT method
examples:
- ACTIVE
Walter Featherstone
committed
DnsRule:
Walter Featherstone
committed
required:
- dnsRuleId
- domainName
- ipAddressType
- ipAddress
- state
type: object
Walter Featherstone
committed
properties:
dnsRuleId:
type: string
description: Identifies the DNS Rule
examples:
- dnsRule1
Walter Featherstone
committed
domainName:
type: string
description: FQDN resolved by the DNS rule
examples:
- www.example.com
Walter Featherstone
committed
ipAddressType:
$ref: '#/components/schemas/DnsRule.IpAddressType'
ipAddress:
type: string
description: IP address associated with the FQDN resolved by the DNS rule
examples:
- 192.0.2.0
Walter Featherstone
committed
ttl:
type: integer
description: Time to live value
contentEncoding: int32
Walter Featherstone
committed
state:
$ref: '#/components/schemas/DnsRule.State'
description: This type represents the general information of a DNS rule.
href:
type: string
description: URI referring to a resource
examples:
- /mecAppSuptApi/example
description: This type represents a type of link and may be referenced from data structures
Walter Featherstone
committed
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecAppSuptApi/example
description: Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout.
title: MecAppSuptApiSubscriptionLinkList.Links
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
self:
$ref: '#/components/schemas/LinkType'
Walter Featherstone
committed
type: array
items:
$ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription'
description: The MEC application instance's subscriptions
description: Self-referring URI.
MecAppSuptApiSubscriptionLinkList.Subscription:
title: MecAppSuptApiSubscriptionLinkList.Subscription
Walter Featherstone
committed
required:
- href
- rel
type: object
Walter Featherstone
committed
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecAppSuptApi/example
Walter Featherstone
committed
rel:
type: string
description: The values shall be set to AppTerminationNotificationSubscription.
description: A link to a subscription.
title: MecAppSuptApiSubscriptionLinkList
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
_links:
$ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links'
description: This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.
- STOPPING
- TERMINATING
type: string
description: Operation that is being performed on the MEC application instance.
examples:
- TERMINATING
Walter Featherstone
committed
ProblemDetails:
Walter Featherstone
committed
type: object
properties:
type:
type: string
description: A URI reference according to IETF RFC 3986 that identifies the problem type
Walter Featherstone
committed
title:
type: string
description: A short, human-readable summary of the problem type
Walter Featherstone
committed
status:
type: integer
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
Walter Featherstone
committed
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
Walter Featherstone
committed
instance:
type: string
description: A URI reference that identifies the specific occurrence of the problem
title: ReadyIndicationType
const: READY
Walter Featherstone
committed
type: string
description: Indication about the MEC application instance.
examples:
- READY
Walter Featherstone
committed
Self:
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
self:
$ref: '#/components/schemas/LinkType'
Walter Featherstone
committed
TimingCaps.NtpServers.AuthenticationOption:
title: TimingCaps.NtpServers.AuthenticationOption
Walter Featherstone
committed
enum:
- NONE
- SYMMETRIC_KEY
- AUTO_KEY
Walter Featherstone
committed
type: string
description: NTP authentication option
examples:
- NONE
Walter Featherstone
committed
TimingCaps.NtpServers.NtpServerAddrType:
title: TimingCaps.NtpServers.NtpServerAddrType
Walter Featherstone
committed
enum:
Walter Featherstone
committed
type: string
description: Address type of NTP server
examples:
- IP_ADDRESS
Walter Featherstone
committed
TimingCaps.NtpServers:
Walter Featherstone
committed
required:
- ntpServerAddrType
- ntpServerAddr
- minPollingInterval
- maxPollingInterval
- localPriority
- authenticationOption
- authenticationKeyNum
type: object
Walter Featherstone
committed
properties:
ntpServerAddrType:
$ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType'
ntpServerAddr:
type: string
description: NTP server address
examples:
- 192.0.2.0
Walter Featherstone
committed
minPollingInterval:
type: integer
description: Minimum poll interval for NTP messages, in seconds as a power of two. Range 3...17
contentEncoding: int32
examples:
- 3
Walter Featherstone
committed
maxPollingInterval:
type: integer
description: Maximum poll interval for NTP messages, in seconds as a power of two. Range 3...17
contentEncoding: int32
examples:
- 17
Walter Featherstone
committed
localPriority:
type: integer
description: NTP server local priority
contentEncoding: int32
examples:
- 1
Walter Featherstone
committed
authenticationOption:
$ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationOption'
authenticationKeyNum:
type: integer
description: Authentication key number
contentEncoding: int32
examples:
- 1
Walter Featherstone
committed
description: NTP server detail.
TimingCaps_PtpMasters:
title: TimingCaps_PtpMasters
Walter Featherstone
committed
required:
- ptpMasterIpAddress
- ptpMasterLocalPriority
- delayReqMaxRate
type: object
Walter Featherstone
committed
properties:
ptpMasterIpAddress:
type: string
description: PTP Master IP Address
examples:
- 192.0.2.0
Walter Featherstone
committed
ptpMasterLocalPriority:
type: integer
description: PTP Master local priority
contentEncoding: int32
examples:
- 1
Walter Featherstone
committed
delayReqMaxRate:
type: integer
description: Acceptable maximum rate of the Delay_Req messages in packets per second
contentEncoding: int32
examples:
- 10
description: NTP server detail.
Walter Featherstone
committed
TimingCaps.TimeStamp:
Walter Featherstone
committed
required:
- seconds
- nanoSeconds
type: object
Walter Featherstone
committed
properties:
seconds:
type: integer
description: The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
- 1577836800
Walter Featherstone
committed
nanoSeconds:
type: integer
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
- 0
description: time
Walter Featherstone
committed
TimingCaps:
Walter Featherstone
committed
type: object
properties:
timeStamp:
$ref: '#/components/schemas/TimingCaps.TimeStamp'
ntpServers:
type: array
items:
$ref: '#/components/schemas/TimingCaps.NtpServers'
Walter Featherstone
committed
ptpMasters:
type: array
items:
$ref: '#/components/schemas/TimingCaps_PtpMasters'
description: Available PTP Masters
description: This type represents the information provided by the MEC platform in response to the Timing capabilities Query message.
Walter Featherstone
committed
TrafficFilter:
Walter Featherstone
committed
type: object
properties:
srcAddress:
type: array
items:
type: string
description: An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.
Walter Featherstone
committed
dstAddress:
type: array
items:
type: string
description: An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.
Walter Featherstone
committed
srcPort:
type: array
items:
Walter Featherstone
committed
description: A port or a range of ports
Walter Featherstone
committed
type: array
items:
type: string
description: A port or a range of ports
Walter Featherstone
committed
protocol:
type: array
items:
type: string
description: Specify the protocol of the traffic filter
Walter Featherstone
committed
token:
type: array
items:
type: string
description: Used for token based traffic rule
Walter Featherstone
committed
srcTunnelAddress:
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
type: string
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
qCI:
type: integer
description: Used to match all packets that have the same Quality Class Indicator (QCI).
contentEncoding: int32
examples:
- 1
Walter Featherstone
committed
dSCP:
type: integer
description: Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)
contentEncoding: int32
examples:
- 0
Walter Featherstone
committed
tC:
type: integer
description: Used to match all IPv6 packets that have the same Traffic Class.
contentEncoding: int32
examples:
- 1
description: This type represents the traffic filter.
Walter Featherstone
committed
TrafficRule.Action:
Walter Featherstone
committed
enum:
- DROP
- FORWARD_DECAPSULATED
- FORWARD_ENCAPSULATED
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_ENCAPSULATED
Walter Featherstone
committed
type: string
description: The action of the MEC host data plane when a packet matches the trafficFilter
examples:
- DROP
TrafficRule.FilterType:
title: TrafficRule.FilterType
Walter Featherstone
committed
enum:
Walter Featherstone
committed
type: string
description: Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context
examples:
- FLOW
Walter Featherstone
committed
TrafficRule.State:
Walter Featherstone
committed
enum:
- ACTIVE
- INACTIVE
type: string
description: Contains the traffic rule state. This attribute may be updated using HTTP PUT method
examples:
- ACTIVE
Walter Featherstone
committed
TrafficRule:
Walter Featherstone
committed
required:
- trafficRuleId
- filterType
- priority
- trafficFilter
- action
- state
type: object
Walter Featherstone
committed
properties:
trafficRuleId:
type: string
description: Identify the traffic rule.
examples:
- TrafficRule1
Walter Featherstone
committed
filterType:
$ref: '#/components/schemas/TrafficRule.FilterType'
priority:
type: integer
description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence
contentEncoding: int32
examples:
- 1
Walter Featherstone
committed
trafficFilter:
Walter Featherstone
committed
type: array
items:
$ref: '#/components/schemas/TrafficFilter'
Walter Featherstone
committed
action:
$ref: '#/components/schemas/TrafficRule.Action'
dstInterface:
$ref: '#/components/schemas/DestinationInterface'
state:
$ref: '#/components/schemas/TrafficRule.State'
description: This type represents the general information of a traffic rule.
Walter Featherstone
committed
TunnelInfo.TunnelType:
Walter Featherstone
committed
enum:
- GTP_U
- GRE
type: string
Walter Featherstone
committed
description: This type represents the tunnel information.
examples:
- GTP_U
TunnelInfo:
title: TunnelInfo
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
tunnelType:
$ref: '#/components/schemas/TunnelInfo.TunnelType'
tunnelDstAddress:
type: string
description: Destination address of the tunnel
Walter Featherstone
committed
examples:
- '?'
tunnelSrcAddress:
type: string
description: Source address of the tunnel
Walter Featherstone
committed
examples:
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
- '?'
description: This type represents the tunnel information.
TimeSourceStatus:
title: TimeSourceStatus
enum:
- TRACEABLE
- NONTRACEABLE
type: string
description: Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source
examples:
- TRACEABLE
security:
- {}
tags:
- name: appTrafficRules
- name: appDnsRules
- name: appSubscriptions
- name: appConfirmTermination
- name: appConfirmReady
- name: timing
- name: callbacks
externalDocs:
description: ETSI GS MEC011 Application Enablement API, V2.1.1
url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf