Newer
Older
description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
description: 'ETSI GS MEC011 Application Enablement API, V1.1.1'
url: >-
http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf
host: '127.0.0.1:8081'
basePath: /exampleAPI/mp1/v1/
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
parameters:
Body.AppTerminationNotificationSubscription:
name: AppTerminationNotificationSubscription
description: >-
Entity body in the request contains a subscription to the mobile edge
application termination notifications that is to be created.
$ref: '#/definitions/AppTerminationNotificationSubscription'
description: The updated state is included in the entity body of the request.
in: body
required: true
schema:
$ref: '#/definitions/DnsRule'
Body.SerAvailabilityNotificationSubscription:
name: SerAvailabilityNotificationSubscription
description: >-
Entity body in the request contains a subscription to the mobile edge
service availability notifications that is to be created.
$ref: '#/definitions/SerAvailabilityNotificationSubscription'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
in: body
required: true
schema:
$ref: '#/definitions/ServiceInfo'
Body.TrafficRule:
name: TrafficRule
description: One or more updated attributes that are allowed to be changed
in: body
required: true
schema:
$ref: '#/definitions/TrafficRule'
Path.AppInstanceId:
name: appInstanceId
description: >-
Represents a mobile edge application instance. Note that the appInstanceId
is allocated by the mobile edge platform manager.
in: path
required: true
type: string
format: uri
Path.DnsRuleId:
name: dnsRuleId
description: Represents a DNS rule.
in: path
required: true
type: string
format: uri
Path.SubscriptionId:
name: subscriptionId
description: >-
Represents a subscription to the notifications from the mobile edge
platform.
in: path
required: true
type: string
format: uri
Path.SubscriptionType:
name: subscriptionType
description: >-
Represents a subscription type to the notifications from the mobile edge
platform.
in: path
required: true
type: string
format: uri
Path.ServiceId:
name: serviceId
description: Represents a mobile edge service instance.
in: path
required: true
type: string
format: uri
Path.TrafficRuleId:
name: trafficRuleId
description: Represents a traffic rule.
in: path
required: true
type: string
format: uri
Query.Ser_category_id:
name: ser_category_id
description: >-
A mobile edge application instance may use ser_category_id as an input
parameter to query the availability of a list of mobile edge service
instances in a serCategory. Either "ser_instance_id" or "ser_name" or
"ser_category_id" or none of them shall be present.
in: query
required: false
type: string
Query.Ser_instance_id:
name: ser_instance_id
description: >-
A mobile edge application instance may use multiple ser_instance_ids as an
input parameter to query the availability of a list of mobile edge service
instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
none of them shall be present.
in: query
required: false
type: array
items:
type: string
Query.Ser_name:
name: ser_name
description: >-
A mobile edge application instance may use multiple ser_names as an input
parameter to query the availability of a list of mobile edge service
instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
none of them shall be present.
in: query
required: false
type: array
items:
type: string
paths:
'/applications/{appInstanceId}/dns_rules':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
description: >-
This method retrieves information about all the DNS rules associated
with a mobile edge application instance.
operationId: ApplicationsDnsRules_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
description: >-
This method retrieves information about a DNS rule associated with a
mobile edge application instance.
operationId: ApplicationsDnsRule_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
222
223
224
225
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
252
253
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
put:
description: 'This method activates, de-activates or updates a traffic rule.'
operationId: ApplicationsDnsRule_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.DnsRule'
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'412':
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/applications/{appInstanceId}/subscriptions':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
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
produces:
- application/json
responses:
'200':
description: >-
Upon success, a response body containing the list of links to the
requested subscriptions is returned.
schema:
type: object
properties:
Mp1SubscriptionLinkList:
$ref: '#/definitions/Mp1SubscriptionLinkList'
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
The POST method may be used to create a new subscription. One example
use case is to create a new subscription to the mobile edge service
availability notifications. Upon success, the response contains entity
body describing the created subscription.
operationId: ApplicationsSubscriptions_POST
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
responses:
description: >-
Entity body in the request contains a subscription to the mobile
edge service availability notifications that is to be created.
description: The resource URI of the created resource
type: string
format: uri
schema:
type: object
properties:
AppTerminationNotificationSubscription:
$ref: '#/definitions/AppTerminationNotificationSubscription'
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
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
produces:
- application/json
responses:
'200':
description: >-
Upon success, a response body containing the requested subscription
is returned.
schema:
type: object
properties:
SerAvailabilityNotificationSubscription:
$ref: '#/definitions/SerAvailabilityNotificationSubscription'
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method deletes a meMp1Subscription. This method is typically used
in "Unsubscribing from service availability event notifications"
procedure.
operationId: ApplicationsSubscription_DELETE
produces:
- application/json
responses:
'204':
description: No Content
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/applications/{appInstanceId}/traffic_rules':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRules_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
examples:
application/json:
TrafficRule:
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
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRule_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
examples:
application/json:
TrafficRule:
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
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRules_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.TrafficRule'
responses:
'200':
description: >-
Upon success, a response body containing data type describing the
updated TrafficRule is returned.
schema:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
examples:
application/json:
TrafficRule:
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
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'412':
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method retrieves information about a list of meService resources.
This method is typically used in "service availability query" procedure
operationId: Services_GET
produces:
- application/json
parameters:
- $ref: '#/parameters/Query.Ser_instance_id'
- $ref: '#/parameters/Query.Ser_name'
- $ref: '#/parameters/Query.Ser_category_id'
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
name: RNI
version: version1
version: ServiceVersion1
state: ACTIVE
transportId: Rest1
transportInfo:
id: TransId12345
name: REST
description: REST API
type: JSON
protocol: HTTP
version: '2.0'
endpoint:
uris:
- /meMp1/service/EntryPoint
addresses:
- host: 192.0.2.0
port: '8080'
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security/TokenEndPoint
serializer: JSON
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method is used to create a meService resource. This method is
typically used in "service availability update and new service
registration" procedure
operationId: Services_POST
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
'201':
description: >-
Upon success, the HTTP response shall include a Location HTTP header
that contains the resource URI of the created resource.
description: The resource URI of the created resource
type: string
format: uri
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
name: RNI
version: version1
version: ServiceVersion1
state: ACTIVE
transportId: Rest1
transportInfo:
id: TransId12345
name: REST
description: REST API
type: JSON
protocol: HTTP
version: '2.0'
endpoint:
uris:
- /meMp1/service/EntryPoint
addresses:
- host: 192.0.2.0
port: '8080'
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security/TokenEndPoint
serializer: JSON
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
parameters:
- $ref: '#/parameters/Path.ServiceId'
description: >-
This method retrieves information about a meService resource. This
method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
name: RNI
version: version1
version: ServiceVersion1
state: ACTIVE
transportId: Rest1
transportInfo:
id: TransId12345
name: REST
description: REST API
type: JSON
protocol: HTTP
version: '2.0'
endpoint:
uris:
- /meMp1/service/EntryPoint
addresses:
- host: 192.0.2.0
port: '8080'
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security/TokenEndPoint
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
put:
description: This method updates the information about a meService resource
operationId: ServicesServiceId_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
'200':
description: >-
Upon success, a response body containing data type describing the
updated ServiceInfo is returned
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
schema:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
name: RNI
version: version1
version: ServiceVersion1
state: ACTIVE
transportId: Rest1
transportInfo:
id: TransId12345
name: REST
description: REST API
type: JSON
protocol: HTTP
version: '2.0'
endpoint:
uris:
- /meMp1/service/EntryPoint
addresses:
- host: 192.0.2.0
port: '8080'
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security/TokenEndPoint
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'412':
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method retrieves the information of the platform's current time
which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: object
properties:
CurrentTime:
$ref: '#/definitions/CurrentTime'
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method retrieves the information of the platform's timing
capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: object
properties:
TimingCaps:
$ref: '#/definitions/TimingCaps'
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
description: >-
This method retrieves information about a list of available transports.
This method is typically used by a service-producing application to
discover transports provided by the mobile edge platform in the
"transport information query" procedure
operationId: Transports_GET
produces:
- application/json
responses:
'200':
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
schema:
type: array
items:
type: object
properties:
TransportInfo:
$ref: '#/definitions/TransportInfo'
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
'400':
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
definitions:
AppTerminationNotification.MaxGracefulTimeout:
description: >-
Maximum timeout value in seconds for graceful termination or graceful stop
of an application instance.
type: string
format: uint32
example: 10
AppTerminationNotification.NotificationType:
description: Shall be set to AppTerminationNotification.
type: string
example: AppTerminationNotification
AppTerminationNotification:
description: >-
This type represents the information that the mobile edge platform
notifies the subscribed application instance about the corresponding
application instance termination/stop.
type: object
required:
- notificationType
- maxGracefulTimeout
- _links
properties:
notificationType:
$ref: '#/definitions/AppTerminationNotification.NotificationType'
maxGracefulTimeout:
$ref: '#/definitions/AppTerminationNotification.MaxGracefulTimeout'
_links:
$ref: '#/definitions/Subscription'
AppTerminationNotificationSubscription.AppInstanceId:
description: It is used as the filtering criterion for the subscribed events.
type: string
example: ID1
AppTerminationNotificationSubscription.CallbackReference:
description: >-
URI selected by the mobile edge application instance to receive
notifications on the subscribed mobile edge application instance
management information. This shall be included in both the request and the
response.
AppTerminationNotificationSubscription:
description: >-
This type represents the information that the mobile edge platform
notifies the subscribed application instance about the corresponding
application instance termination/stop.
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
type: object
required:
- subscriptionType
- callbackReference
- _links
- appInstanceId
properties:
subscriptionType:
$ref: '#/definitions/AppTerminationNotificationSubscription.SubscriptionType'
callbackReference:
$ref: '#/definitions/AppTerminationNotificationSubscription.CallbackReference'
_links:
$ref: '#/definitions/Self'
appInstanceId:
$ref: '#/definitions/AppTerminationNotificationSubscription.AppInstanceId'
AppTerminationNotificationSubscription.SubscriptionType:
description: Shall be set to AppTerminationNotificationSubscription.
type: string
example: AppTerminationNotificationSubscription
CategoryRef.Href:
description: Reference of the catalogue
type: string
example: catItem1
CategoryRef.Id:
description: Unique identifier of the category
type: string
example: id12345
CategoryRef.Name:
description: Name of the category
type: string
example: RNI
CategoryRef.Version:
description: Category version
type: string
example: version1
CategoryRef:
description: This type represents the category reference
type: object
required:
- href
- id
- name
- version
properties:
href:
$ref: '#/definitions/CategoryRef.Href'
id:
$ref: '#/definitions/CategoryRef.Id'
name:
$ref: '#/definitions/CategoryRef.Name'
version:
$ref: '#/definitions/CategoryRef.Version'
CurrentTime:
description: >-
This type represents the information provided by the mobile edge platform
in response to the Get Platform Time Request message.
type: object
required:
- nanoSeconds
- seconds
- timeSourceStatus
properties:
seconds:
type: integer
format: uint32
description: >-
The seconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
example: 1577836800
nanoSeconds:
type: integer
format: uint32
description: >-
The nanoseconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
example: 0
timeSourceStatus:
type: string
enum:
- TRACEABLE
- NONTRACEABLE
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
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
example: TRACEABLE
DestinationInterface.InterfaceType:
description: Type of the interface
type: string
enum:
- TUNNEL
- MAC
- IP
example: TUNNEL
DestinationInterface.IpAddress:
description: IP address of the remote destination
type: string
example: 192.0.2.0
DestinationInterface.MacAddress:
description: Source address identifies the MAC address of the interface
type: string
example: 02-00-00-00-00-00
DestinationInterface:
description: This type represents the destination interface.
type: object
required:
- interfaceType
properties:
interfaceType:
$ref: '#/definitions/DestinationInterface.InterfaceType'
tunnelInfo:
$ref: '#/definitions/TunnelInfo'
srcMacAddress:
$ref: '#/definitions/DestinationInterface.MacAddress'
dstMacAddress:
$ref: '#/definitions/DestinationInterface.MacAddress'
dstIpAddress:
$ref: '#/definitions/DestinationInterface.IpAddress'
DnsRule.DomainName:
description: FQDN resolved by the DNS rule
type: string
example: www.example.com
DnsRule.Id:
description: Identifies the DNS Rule
type: string
example: dnsRule1
DnsRule.IpAddress:
description: IP address associated with the FQDN resolved by the DNS rule
type: string
example: 192.0.2.0
DnsRule.IpAddressType:
description: IP address type
type: string
enum:
- IP_V6
- IP_V4
example: IP_V6
DnsRule.State:
description: DNS rule state
type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
DnsRule.Ttl:
description: Time to live value
type: integer
format: uint32
example: '?'
DnsRule:
description: This type represents the general information of a DNS rule.
type: object
required:
- dnsRuleId
- domainName
- ipAddressType
- ipAddress
- state
properties:
dnsRuleId:
$ref: '#/definitions/DnsRule.Id'
domainName:
$ref: '#/definitions/DnsRule.DomainName'
ipAddressType:
$ref: '#/definitions/DnsRule.IpAddressType'
ipAddress:
$ref: '#/definitions/DnsRule.IpAddress'
ttl:
$ref: '#/definitions/DnsRule.Ttl'
state:
$ref: '#/definitions/DnsRule.State'
EndPointInfo.Address.Host:
description: Host portion of the address
type: string
example: 192.0.2.0
EndPointInfo.Address.Port:
description: Port portion of the address
type: integer
format: uint32
example: '8080'
EndPointInfo.Address:
description: A IP address and port pair
type: object
properties:
host:
$ref: '#/definitions/EndPointInfo.Address.Host'
port:
$ref: '#/definitions/EndPointInfo.Address.Port'
EndPointInfo.Addresses:
description: >-
Entry point information of the service as one or more pairs of IP address
and port
type: array
items:
$ref: '#/definitions/EndPointInfo.Address'
EndPointInfo.Alternative:
description: >-
Entry point information of the service in a format defined by an
implementation, or in an external specification.
type: object
EndPointInfo.Uri:
description: Entry point information of the service
type: string
format: uri
example: /meMp1/service/EntryPoint
EndPointInfo.Uris:
description: >-
Entry point information of the service as string, formatted according to
URI syntax
type: array
items:
$ref: '#/definitions/EndPointInfo.Uri'
EndPointInfo:
description: This type represents information about a transport endpoint
type: object
properties:
uris:
$ref: '#/definitions/EndPointInfo.Uris'
addresses:
$ref: '#/definitions/EndPointInfo.Addresses'
alternative:
$ref: '#/definitions/EndPointInfo.Alternative'
LinkType:
description: URI referring to a resource
type: string
format: uri
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
example: /meMp1/example
Mp1SubscriptionLinkList.Links:
description: Self-referring URI.
type: object
required:
- self
properties:
self:
$ref: '#/definitions/LinkType'
subscription:
description: Subscription list
type: array
items:
$ref: '#/definitions/Mp1SubscriptionLinkList.Subscription'
Mp1SubscriptionLinkList.Subscription:
description: A link to a subscription.
type: object
required:
- href
- rel
properties:
href:
description: The URI referring to the subscription
type: string
format: uri
rel:
description: >-
The values are as defined in the "subscriptionType" attribute for each
different Mp1 event subscription data type.
type: string
Mp1SubscriptionLinkList:
description: >-
This type represents a list of links related to currently existing
subscriptions for a mobile edge application instance. This information is
returned when sending a request to receive current subscriptions.
type: object
required:
- _links
properties:
_links:
$ref: '#/definitions/Mp1SubscriptionLinkList.Links'
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
ProblemDetails:
type: object
properties:
type:
$ref: '#/definitions/Problem.type'
title:
$ref: '#/definitions/Problem.title'
status:
$ref: '#/definitions/Problem.status'
detail:
$ref: '#/definitions/Problem.detail'
instance:
$ref: '#/definitions/Problem.instance'
Problem.detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
Problem.instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
Problem.status:
type: integer
format: uint32
description: The HTTP status code for this occurrence of the problem
Problem.title:
type: string
description: 'A short, human-readable summary of the problem type'
Problem.type:
type: string
format: uri
description: >-
A URI reference according to IETF RFC 3986 that identifies the problem
type
SecurityInfo.OAuth2Info.GrantTypes:
description: List of supported OAuth 2.0 grant types
type: string
enum:
- OAUTH2_AUTHORIZATION_CODE
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
example: OAUTH2_CLIENT_CREDENTIALS
SecurityInfo.OAuth2Info.TokenEndpoint:
description: The token endpoint
type: string
format: uri
example: /meMp1/security/TokenEndPoint
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
SecurityInfo.OAuth2Info:
description: Parameters related to use of OAuth 2.0
required:
- grantTypes
- tokenEndpoint
properties:
grantTypes:
$ref: '#/definitions/SecurityInfo.OAuth2Info.GrantTypes'
tokenEndpoint:
$ref: '#/definitions/SecurityInfo.OAuth2Info.TokenEndpoint'
SecurityInfo:
description: This type represents security information related to a transport
type: object
required:
- oAuth2Info
properties:
oAuth2Info:
$ref: '#/definitions/SecurityInfo.OAuth2Info'
Self:
description: Self-referring URI.
type: object
required:
- self
properties:
self:
$ref: '#/definitions/LinkType'
SerAvailabilityNotificationSubscription.CallbackReference:
description: >-
URI selected by the mobile edge application instance to receive
notifications on the subscribed mobile edge service availability
information. This shall be included in both the request and the response.
SerAvailabilityNotificationSubscription:
description: >-
This type represents a subscription to the notifications from the mobile
edge platform regarding the availability of a mobile edge service or a
list of mobile edge services.
type: object
required:
- subscriptionType
- callbackReference
- _links
- filteringCriteria
properties:
subscriptionType:
$ref: '#/definitions/SerAvailabilityNotificationSubscription.SubscriptionType'
callbackReference:
$ref: >-
#/definitions/SerAvailabilityNotificationSubscription.CallbackReference
_links:
$ref: '#/definitions/Self'
filteringCriteria:
$ref: '#/definitions/ServiceInfo'
SerAvailabilityNotificationSubscription.SubscriptionType:
description: Shall be set to SerAvailabilityNotificationSubscription.
type: string
example: SerAvailabilityNotificationSubscription
SerializerTypes:
description: The enumeration SerializerTypes represents types of serializers
type: string
enum:
- JSON
- XML
- PROTOBUF3
example: JSON
ServiceInfo.SerInstanceId:
description: >-
Identifier of the service instance assigned by the MEPM / mobile edge
platform.
type: string
example: ServiceInstance123
ServiceInfo.SerName:
description: >-
The name of the service. This is how the service producing mobile edge
application identifies the service instance it produces.
type: string
example: ExampleService
ServiceInfo.State:
description: Contains the state
type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
ServiceInfo.TransportId:
description: >-
Identifier of the platform-provided transport to be used by the service.
Valid identifiers may be obtained using the "Transport information query"
procedure. May be present in POST requests to signal the use of a
platform-provided transport for the service, and shall be absent
otherwise.
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
type: string
example: Rest1
ServiceInfo.Version:
description: Service version
type: string
example: ServiceVersion1
ServiceInfo:
description: This type represents the general information of a mobile edge service.
type: object
required:
- serName
- version
- state
- serializer
properties:
serInstanceId:
$ref: '#/definitions/ServiceInfo.SerInstanceId'
serName:
$ref: '#/definitions/ServiceInfo.SerName'
serCategory:
$ref: '#/definitions/CategoryRef'
version:
$ref: '#/definitions/ServiceInfo.Version'
state:
$ref: '#/definitions/ServiceInfo.State'
transportId:
$ref: '#/definitions/ServiceInfo.TransportId'
transportInfo:
$ref: '#/definitions/TransportInfo'
serializer:
$ref: '#/definitions/SerializerTypes'
Subscription:
description: A link to the related subscription
type: object
required:
- subscription
properties:
subscription:
$ref: '#/definitions/LinkType'
TimingCaps.NtpServers.AuthenticationKeyNum:
description: Authentication key number
type: integer
format: uint32
example: 1
TimingCaps.NtpServers.AuthenticationOption:
description: NTP authentication option
type: string
enum:
- NONE
- SYMMETRIC_KEY
- AUTO_KEY
example: NONE
TimingCaps.NtpServers.DelayReqMaxRate:
description: Acceptable maximum rate of the Delay_Req messages in packets per second
type: integer
format: uint32
example: 10
TimingCaps.NtpServers.LocalPriority:
description: NTP server local priority
type: integer
format: uint32
example: 1
TimingCaps.NtpServers.MaxPollingInterval:
description: >-
Maximum poll interval for NTP messages, in seconds as a power of two.
Range 3...17
type: integer
format: uint32
example: 17
TimingCaps.NtpServers.MinPollingInterval:
description: >-
Minimum poll interval for NTP messages, in seconds as a power of two.
Range 3...17
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
type: integer
format: uint32
example: 3
TimingCaps.NtpServers.NtpServerAddr:
description: NTP server address
type: string
example: 192.0.2.0
TimingCaps.NtpServers.NtpServerAddrType:
description: Address type of NTP server
type: string
enum:
- IP_ADDRESS
- DNS_NAME
example: IP_ADDRESS
TimingCaps.NtpServers.PtpMasterIpAddress:
description: PTP Master IP Address
type: string
example: 192.0.2.0
TimingCaps.NtpServers.PtpMasterLocalPriority:
description: PTP Master local priority
type: integer
format: uint32
example: 1
TimingCaps.NtpServers:
description: NTP server detail.
type: object
required:
- ntpServerAddrType
- ntpServerAddr
- minPollingInterval
- maxPollingInterval
- localPriority
- authenticationOption
- authenticationKeyNum
properties:
ntpServerAddrType:
$ref: '#/definitions/TimingCaps.NtpServers.NtpServerAddrType'
ntpServerAddr:
$ref: '#/definitions/TimingCaps.NtpServers.NtpServerAddr'
minPollingInterval:
$ref: '#/definitions/TimingCaps.NtpServers.MinPollingInterval'
maxPollingInterval:
$ref: '#/definitions/TimingCaps.NtpServers.MaxPollingInterval'
localPriority:
$ref: '#/definitions/TimingCaps.NtpServers.LocalPriority'
authenticationOption:
$ref: '#/definitions/TimingCaps.NtpServers.AuthenticationOption'
authenticationKeyNum:
$ref: '#/definitions/TimingCaps.NtpServers.AuthenticationKeyNum'
TimingCaps.PtpMasters:
description: NTP server detail.
type: object
required:
- ptpMasterIpAddress
- ptpMasterLocalPriority
- delayReqMaxRate
properties:
ptpMasterIpAddress:
$ref: '#/definitions/TimingCaps.NtpServers.PtpMasterIpAddress'
ptpMasterLocalPriority:
$ref: '#/definitions/TimingCaps.NtpServers.PtpMasterLocalPriority'
delayReqMaxRate:
$ref: '#/definitions/TimingCaps.NtpServers.DelayReqMaxRate'
TimingCaps.TimeStamp:
description: time
type: object
required:
- nanoSeconds
- seconds
properties:
seconds:
type: integer
format: uint32
description: >-
The seconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
example: 1577836800
nanoSeconds:
type: integer
format: uint32
description: >-
The nanoseconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
description: >-
This type represents the information provided by the mobile edge platform
in response to the Timing capabilities Query message.
type: object
properties:
timeStamp:
$ref: '#/definitions/TimingCaps.TimeStamp'
ntpServers:
description: Available NTP servers
type: array
items:
$ref: '#/definitions/TimingCaps.NtpServers'
ptpMasters:
description: Available PTP Masters
type: array
items:
$ref: '#/definitions/TimingCaps.PtpMasters'
TrafficFilter.Address:
description: Identify the traffic ip address.
example: 192.168.1.1
description: >-
Used to match all IPv4 packets that have the same Differentiated Services
Code Point (DSCP)
type: integer
format: uint32
example: 0
TrafficFilter.Port:
description: A port
type: string
example: '8080'
TrafficFilter.Protocol:
description: Protocol of the traffic filter
type: string
example: '?'
TrafficFilter.QCI:
description: >-
Used to match all packets that have the same Quality Class Indicator
(QCI).
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
type: integer
format: uint32
example: 1
TrafficFilter.TC:
description: Used to match all IPv6 packets that have the same Traffic Class.
type: integer
format: uint32
example: 1
TrafficFilter.Token:
description: Used for token based traffic rule
type: string
example: '?'
TrafficFilter.TunnelAddress:
description: Used for GTP tunnel based traffic rule
type: string
example: '?'
TrafficFilter.TunnelPort:
description: Used for GTP tunnel based traffic rule
type: string
example: '?'
TrafficFilter:
description: This type represents the traffic filter.
type: object
properties:
srcAddress:
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.
type: array
items:
$ref: '#/definitions/TrafficFilter.Address'
dstAddress:
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.
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
type: array
items:
$ref: '#/definitions/TrafficFilter.Address'
srcPort:
description: A port or a range of ports
type: array
items:
$ref: '#/definitions/TrafficFilter.Port'
dstPort:
description: A port or a range of ports
type: array
items:
$ref: '#/definitions/TrafficFilter.Port'
protocol:
description: Specify the protocol of the traffic filter
type: array
items:
$ref: '#/definitions/TrafficFilter.Protocol'
token:
description: Used for token based traffic rule
type: array
items:
$ref: '#/definitions/TrafficFilter.Token'
srcTunnelAddress:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/definitions/TrafficFilter.TunnelAddress'
tgtTunnelAddress:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/definitions/TrafficFilter.TunnelAddress'
srcTunnelPort:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/definitions/TrafficFilter.TunnelPort'
dstTunnelPort:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/definitions/TrafficFilter.TunnelPort'
qCI:
$ref: '#/definitions/TrafficFilter.QCI'
dSCP:
$ref: '#/definitions/TrafficFilter.DSCP'
tC:
$ref: '#/definitions/TrafficFilter.TC'
TrafficRule.Action:
description: >-
The action of the ME host data plane when a packet matches the
trafficFilter
type: string
enum:
- DROP
- FORWARD_DECAPSULATED
- FORWARD_AS_IS
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_AS_IS
example: DROP
TrafficRule.FilterType:
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
type: string
enum:
- FLOW
- PACKET
example: FLOW
TrafficRule.Id:
description: Identify the traffic rule.
type: string
example: TrafficRule1
TrafficRule.Priority:
description: >-
Priority of this traffic rule. If traffic rule conflicts, the one with
higher priority take precedence
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
type: integer
format: uint32
example: 1
TrafficRule.State:
description: Contains the traffic rule state
type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
TrafficRule:
description: This type represents the general information of a traffic rule.
type: object
required:
- trafficRuleId
- filterType
- priority
- trafficFilter
- action
- state
properties:
trafficRuleId:
$ref: '#/definitions/TrafficRule.Id'
filterType:
$ref: '#/definitions/TrafficRule.FilterType'
priority:
$ref: '#/definitions/TrafficRule.Priority'
trafficFilter:
$ref: '#/definitions/TrafficFilter'
action:
$ref: '#/definitions/TrafficRule.Action'
dstInterface:
$ref: '#/definitions/DestinationInterface'
state:
$ref: '#/definitions/TrafficRule.State'
TransportInfo.Description:
description: Human-readable description of this transport
type: string
example: REST API
TransportInfo.Id:
description: The identifier of this transport
type: string
example: TransId12345
TransportInfo.ImplSpecificInfo:
description: Additional implementation specific details of the transport
type: object
TransportInfo.Name:
description: The name of this transport
type: string
example: REST
TransportInfo.Protocol:
description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string
example: HTTP
TransportInfo.Version:
description: The version of the protocol used
type: string
example: '2.0'
TransportInfo:
description: This type represents the general information of a mobile edge service.
type: object
required:
- id
- name
- type
- protocol
- version
- endpoint
properties:
id:
$ref: '#/definitions/TransportInfo.Id'
name:
$ref: '#/definitions/TransportInfo.Name'
description:
$ref: '#/definitions/TransportInfo.Description'
type:
$ref: '#/definitions/TransportTypes'
protocol:
$ref: '#/definitions/TransportInfo.Protocol'
version:
$ref: '#/definitions/TransportInfo.Version'
endpoint:
$ref: '#/definitions/EndPointInfo'
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
$ref: '#/definitions/SecurityInfo'
implSpecificInfo:
$ref: '#/definitions/TransportInfo.ImplSpecificInfo'
TransportTypes:
description: The enumeration TransportTypes represents types of transports
type: string
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
example: JSON
TunnelInfo.TunnelDstAddress:
description: Destination address of the tunnel
type: string
example: '?'
TunnelInfo.TunnelSrcAddress:
description: Source address of the tunnel
type: string
example: '?'
TunnelInfo.TunnelType:
description: This type represents the tunnel information.
type: string
enum:
- GTP_U
- GRE
example: GTP_U
TunnelInfo:
description: This type represents the tunnel information.
type: object
required:
- tunnelType
properties:
tunnelType:
$ref: '#/definitions/TunnelInfo.TunnelType'
tunnelDstAddress:
$ref: '#/definitions/TunnelInfo.TunnelDstAddress'
tunnelSrcAddress:
$ref: '#/definitions/TunnelInfo.TunnelSrcAddress'