Newer
Older
openapi: 3.0.2
servers:
- url: 'http://127.0.0.1:8081/rni/v2'
- url: 'https://127.0.0.1:8081/rni/v2'
title: MEC Radion Network Information API
version: 2.1.1
description: The ETSI MEC ISG MEC012 Radio Network Information API
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
description: ETSI GS MEC012 Radio Network Information API, V2.1.1
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf'
tags:
- name: layer2_meas
- name: plmn_info
- name: rabInfo
- name: s1_bearer_info
- name: subscriptions
/queries/rab_info:
get:
description: >-
Gets information on existing E-RABs that are associated with a specific
mobile edge application instance
operationId: rab_infoGET
Michele Carignani
committed
- $ref: '#/components/parameters/Query.AppInsId'
- $ref: '#/components/parameters/Query.CellId'
- $ref: '#/components/parameters/Query.UeIpv4Address'
- $ref: '#/components/parameters/Query.UeIpv6Address'
- $ref: '#/components/parameters/Query.NatedIpAddress'
- $ref: '#/components/parameters/Query.GtpTeId'
- $ref: '#/components/parameters/Query.ErabId'
- $ref: '#/components/parameters/Query.Qci'
- $ref: '#/components/parameters/Query.ErabMbrDl'
- $ref: '#/components/parameters/Query.ErabMbrUl'
- $ref: '#/components/parameters/Query.ErabGbrDl'
- $ref: '#/components/parameters/Query.ErabGbrUl'
responses:
'200':
description: Successful response to rab_info request
Michele Carignani
committed
content:
Michele Carignani
committed
schema:
type: object
required:
- RabInfo
properties:
RabInfo:
$ref: '#/components/schemas/RabInfo'
example:
RabInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
appInId: '01'
requestId: '01'
cellUserInfo:
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
ueInfo:
associateId: null
type: '1'
value: 192.0.2.0
erabInfo:
erabId: 10
erabQosParameters:
qci: 7
qosInformation:
erabMbrDl: 10
erabMbrUl: 10
erabGbrDl: 10
erabGbrUl: 10
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/queries/plmn_info:
Michele Carignani
committed
Gets the information on Mobile Network(s).
Michele Carignani
committed
- $ref: '#/components/parameters/Query.AppInsIdArr'
responses:
'200':
description: Successful response to rab_info request
Michele Carignani
committed
content:
Michele Carignani
committed
schema:
type: object
properties:
PlmnInfo:
$ref: '#/components/schemas/PlmnInfo'
example:
PlmnInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
appInId: '01'
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
Michele Carignani
committed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/queries/s1_bearer_info:
get:
description: >-
Gets information on existing E-RABs that are associated with a specific
mobile edge application instance. Queries information about the S1 bearer(s).
Michele Carignani
committed
- $ref: '#/components/parameters/Query.TempUeId'
- $ref: '#/components/parameters/Query.UeIpv4Address'
- $ref: '#/components/parameters/Query.UeIpv6Address'
- $ref: '#/components/parameters/Query.NatedIpAddress'
- $ref: '#/components/parameters/Query.GtpTeId'
- $ref: '#/components/parameters/Query.CellId'
- $ref: '#/components/parameters/Query.ErabIdArr'
responses:
'200':
description: Successful response to s1_bearer_info request
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
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
schema:
type: object
required:
- S1BearerInfo
properties:
S1BearerInfo:
$ref: '#/components/schemas/S1BearerInfo'
example:
S1BearerInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
s1UeInfo:
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
- type: '1'
value: 192.0.2.0
- type: '3'
value: 198.51.100.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
s1BearerInfoDetailed:
- erabId: 1
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '1111'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '2222'
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
type: '1'
value: 192.0.2.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000B'
s1BearerInfoDetailed:
- erabId: 2
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '3333'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '4444'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/queries/layer2_meas:
x-etsi-ref: 7.5a.1
Gets information on existing E-RABs that are associated with a specific
mobile edge application instance. Queries information about the S1 bearer(s).
operationId: layer2_meas_infoGET
x-etsi-ref: 7.5a.3.1
parameters:
- $ref: '#/components/parameters/Query.AppInsId'
- $ref: '#/components/parameters/Query.CellId'
- $ref: '#/components/parameters/Query.UeIpv4Address'
- $ref: '#/components/parameters/Query.UeIpv6Address'
- $ref: '#/components/parameters/Query.NatedIpAddress'
- $ref: '#/components/parameters/Query.GtpTeId'
- $ref: '#/components/parameters/Query.DlGbrPrbUsageCell'
- $ref: '#/components/parameters/Query.UlGbrPrbUsageCell'
- $ref: '#/components/parameters/Query.DlNongbrPrbUsageCell'
- $ref: '#/components/parameters/Query.UlNongbrPrbUsageCell'
- $ref: '#/components/parameters/Query.DlTotalPrbUsageCell'
- $ref: '#/components/parameters/Query.UlTotalPrbUsageCell'
- $ref: '#/components/parameters/Query.ReceivedDedicatedPreamblesCell'
- $ref: '#/components/parameters/Query.ReceivedRandomlySelectedPreamblesLowRangeCell'
- $ref: '#/components/parameters/Query.ReceivedRandomlySelectedPreamblesHighRangeCell'
- $ref: '#/components/parameters/Query.NumberOfActiveUeDlGbrCell'
- $ref: '#/components/parameters/Query.NumberOfActiveUeUlGbrCell'
- $ref: '#/components/parameters/Query.NumberOfActiveUeDlNongbrCell'
- $ref: '#/components/parameters/Query.NumberOfActiveUeUlNongbrCell'
- $ref: '#/components/parameters/Query.DlGbrPdrCell'
- $ref: '#/components/parameters/Query.UlGbrPdrCell'
- $ref: '#/components/parameters/Query.DlNongbrPdrCell'
- $ref: '#/components/parameters/Query.UlNongbrPdrCell'
- $ref: '#/components/parameters/Query.DlGbrDelayUe'
- $ref: '#/components/parameters/Query.UlGbrDelayUe'
- $ref: '#/components/parameters/Query.DlNongbrDelayUe'
- $ref: '#/components/parameters/Query.UlNongbrDelayUe'
- $ref: '#/components/parameters/Query.DlGbrPdrUe'
- $ref: '#/components/parameters/Query.UlGbrPdrUe'
- $ref: '#/components/parameters/Query.DlNongbrPdrUe'
- $ref: '#/components/parameters/Query.UlNongbrPdrUe'
- $ref: '#/components/parameters/Query.DlGbrThroughputUe'
- $ref: '#/components/parameters/Query.UlGbrThroughputUe'
- $ref: '#/components/parameters/Query.DlNongbrThroughputUe'
- $ref: '#/components/parameters/Query.UlNongbrThroughputUe'
- $ref: '#/components/parameters/Query.DlGbrDataVolumeUe'
- $ref: '#/components/parameters/Query.UlGbrDataVolumeUe'
- $ref: '#/components/parameters/Query.DlNongbrDataVolumeUe'
- $ref: '#/components/parameters/Query.UlNongbrDataVolumeUe'
description: Successful response to s1_bearer_info request
content:
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
schema:
type: object
required:
- S1BearerInfo
properties:
S1BearerInfo:
$ref: '#/components/schemas/S1BearerInfo'
example:
S1BearerInfo:
timeStamp:
seconds: 1577836800
nanoSeconds: 0
s1UeInfo:
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
- type: '1'
value: 192.0.2.0
- type: '3'
value: 198.51.100.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000A'
s1BearerInfoDetailed:
- erabId: 1
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '1111'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '2222'
- tempUeId:
mmec: '0'
mtmsi: '1234'
associateId:
type: '1'
value: 192.0.2.0
ecgi:
plmn:
mcc: '001'
mnc: '01'
cellId: '0x800000B'
s1BearerInfoDetailed:
- erabId: 2
s1EnbInfo:
ipAddress: 192.0.2.0
tunnelId: '3333'
sGwInfo:
ipAddress: 192.0.2.1
tunnelId: '4444'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
The GET method is used to request information about the subscriptions
for this requestor. Upon success, the response contains entity body
with the list of links to the subscriptions that are present for the
requestor.
operationId: SubscriptionLinkList_subscriptionsGET
x-etsi-ref: 7.6.3.1
parameters:
- name: subscription_type
in: query
required: false
description: Query parameter to filter on a specific subscription type.
schema:
enum:
- cell_change # Cell Change
- rab_est # RAB # Establishment
- rab_mod # RAB Modification
- rab_rel # RAB Release
- meas_rep_ue # UE Measurement Report
- nr_meas_rep_ue # 5G UE Measurement Report
- timing_advance_ue # UE Timing Advance
- ca_reconf # Carrier Aggregation Reconfig
- s1_bearer # S1 Bearer Notification
responses:
'200':
description: >-
Response body contains the list of links to requestors
schema:
type: object
required:
- SubscriptionLinkList
properties:
SubscriptionLinkList:
$ref: '#/components/schemas/SubscriptionLinkList'
example:
SubscriptionLinkList:
_links:
self: 'http://meAppServer.example.com/rni/v1/subscriptions'
subscription:
- href: >-
http://meAppClient.example.com/rni/v1/notifications/cell_change/77777
subscriptionType: CELL_CHANGE
- href: >-
http://meAppClient.example.com/rni/v1/notifications/MeasTa/77777
subscriptionType: MEAS_TIMING_ADVANCE
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
x-swagger-router-controller: Default
post:
description: >-
The POST method is used to create a new subscription to Radio Network
Information notifications. Upon success, the response contains entity
body describing the created subscription.
operationId: SubscriptionLinkList_subscriptionsPOST
x-etsi-ref: 7.6.3.4
requestBody:
description: >-
The entity body in the request contains data type of the specific
RNI event subscription that is to be created, where the data type options
are listed below and defined in clauses 6.3.2 through 6.3.9 and in 6.3.11.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSubscription'
description: >-
Created
Indicates successful resource creation, where the resource URI shall be returned in
the HTTP Location header field.
In the returned NotificationSubscription structure, the created subscription
is described using the appropriate data type from the list below and as defined
in clauses 6.3.2 through 6.3.9 and in 6.3.11.
content:
schema:
oneOf:
- $ref: '#/components/schemas/CellChangeSubscription'
- $ref: '#/components/schemas/RabEstSubscription'
- $ref: '#/components/schemas/RabModSubscription'
- $ref: '#/components/schemas/RabRelSubscription'
- $ref: '#/components/schemas/MeasRepUeSubscription'
- $ref: '#/components/schemas/NrMeasRepUeSubscription'
- $ref: '#/components/schemas/MeasTaSubscription'
- $ref: '#/components/schemas/CaReConfSubscription'
- $ref: '#/components/schemas/S1BearerSubscription'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
/subscriptions/{subscriptionId}:
x-etsi-ref: 7.8.2
The GET method is used to retrieve information about this subscription.
Upon success, the response contains entity body with the data type describing
the subscription.
operationId: IndividualSubscription_subscriptionsGET
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
Walter Featherstone
committed
'200':
OK
Upon success, a response body containing data type describing the specific RNI event
subscription is returned.
The allowed data types for subscriptions are defined in clauses 6.3.2 through
6.3.9 and in 6.3.11.
content:
schema:
$ref: '#/components/schemas/NotificationSubscription'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
The PUT method is used to update the existing subscription. PUT method in
this case has "replace" semantics. Upon successful operation, the target resource
is updated with new Data Type received within the message body of the PUT request.
operationId: IndividualSubscription_subscriptionsPUT
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
requestBody:
description: >-
New NotificationSubscription is included as entity body of the request.
The allowed data types for subscriptions are defined in clauses 6.3.2 through
6.3.9 and in 6.3.11.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSubscription'
Walter Featherstone
committed
'200':
description: Successful subscription to response to cell change notifications
content:
schema:
$ref: '#/components/schemas/NotificationSubscription'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: Not Acceptable
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'412':
description: Precondition failed
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
example:
ProblemDetails:
type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
title: Too many targets
status: '422'
detail: The target area for the request is considered too large
instance: '/meAppClient.example.com/77777/msgs/abc'
'429':
description: Too Many Requests
content:
application/json:
schema:
type: object
properties:
ProblemDetails:
$ref: '#/components/schemas/ProblemDetails'
delete:
description: Method to delete a subscription
operationId: CellChange_subscriptionsSubscrIdDELETE
x-etsi-ref: 7.8.3.5
Michele Carignani
committed
- $ref: '#/components/parameters/Path.subscrId'
responses:
'204':
description: No Content
x-swagger-router-controller: Default
Michele Carignani
committed
949
950
951
952
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
parameters:
Path.subscrId:
name: subscriptionId
in: path
description: >-
Subscription Id, specifically the "self" returned in the subscription
request
required: true
schema:
type: string
format: uri
Query.AppInsId:
name: app_ins_id
in: query
description: Application instance identifier
required: false
schema:
type: string
Query.AppInsIdArr:
name: app_ins_id
in: query
description: Application instance identifier
required: true
schema:
type: array
items:
type: string
Query.UeIpv4Address:
name: ue_ipv4_address
in: query
description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
required: false
schema:
type: array
items:
type: string
Query.UeIpv6Address:
name: ue_ipv6_address
in: query
description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
required: false
schema:
type: array
items:
type: string
Query.NatedIpAddress:
name: nated_ip_address
in: query
description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
required: false
schema:
type: array