Newer
Older
"title": "ETSI GS MEC 012 - Radio Network Information API",
"description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.",
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs012-rnis-api"
},
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"description": "ETSI GS MEC 012 Radio Network Information API, V2.1.1",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf"
"url": "https://localhost/rni/v2"
}
],
"tags": [
{
"name": "rni"
"summary": "Retrieve information on Radio Access Bearers",
"description": "Queries information about the Radio Access Bearers",
"operationId": "rab_infoGET",
"name": "app_ins_id",
"in": "query",
"description": "Application instance identifier",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
"name": "cell_id",
"in": "query",
"description": "Comma separated list of E-UTRAN Cell Identities",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv4_address",
"in": "query",
"description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv6_address",
"in": "query",
"description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "nated_ip_address",
"in": "query",
"description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "gtp_teid",
"in": "query",
"description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "erab_id",
"in": "query",
"description": "E-RAB identifier",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "qci",
"in": "query",
"description": "QoS Class Identifier as defined in ETSI TS 123 401",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "erab_mbr_dl",
"in": "query",
"description": "Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "erab_mbr_ul",
"in": "query",
"description": "Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "erab_gbr_dl",
"in": "query",
"description": "Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "erab_gbr_ul",
"in": "query",
"description": "Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
}
],
"responses": {
"200": {
"description": "Successful response to rab_info request",
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : 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"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"deprecated": false
},
"parameters": []
"summary": "Queries information about the Mobile Network",
"description": "Queries information about the Mobile Network",
"operationId": "plmn_infoGET",
"name": "app_ins_id",
"in": "query",
"description": "Comma separated list of Application instance identifiers",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Successful response to plmn_info request",
"type": "array",
"items": {
"$ref": "#/components/schemas/PlmnInfo"
},
"description": "",
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : 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"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"deprecated": false
},
"parameters": []
"summary": "Retrieve S1-U bearer information related to specific UE(s)'",
"description": "Queries information about the S1 bearer(s)",
"operationId": "s1_bearer_infoGET",
"name": "temp_ue_id",
"in": "query",
"description": "Comma separated list of temporary identifiers allocated for the specific UE as defined in ETSI TS 136 413",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv4_address",
"in": "query",
"description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv6_address",
"in": "query",
"description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "nated_ip_address",
"in": "query",
"description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "gtp_teid",
"in": "query",
"description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "cell_id",
"in": "query",
"description": "Comma separated list of E-UTRAN Cell Identities",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "erab_id",
"in": "query",
"description": "Comma separated list of E-RAB identifiers",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
}
}
}
],
"responses": {
"200": {
"description": "Successful response to s1_bearer_info request",
"content": {
"application/json": {
"schema": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found : 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"
}
}
}
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"deprecated": false
},
"parameters": []
],
"summary": "Retrieve information on layer 2 measurements",
"description": "Queries information about the layer 2 measurements.",
"operationId": "layer2_meas_infoGET",
"parameters": [
{
"name": "app_ins_id",
"in": "query",
"description": "Application instance identifier",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
"name": "cell_id",
"in": "query",
"description": "Comma separated list of E-UTRAN Cell Identities",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv4_address",
"in": "query",
"description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "ue_ipv6_address",
"in": "query",
"description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "nated_ip_address",
"in": "query",
"description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "gtp_teid",
"in": "query",
"description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
"name": "dl_gbr_prb_usage_cell",
"in": "query",
"description": "PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_prb_usage_cell",
"in": "query",
"description": "PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_prb_usage_cell",
"in": "query",
"description": "PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_prb_usage_cell",
"in": "query",
"description": "PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_total_prb_usage_cell",
"in": "query",
"description": "PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_total_prb_usage_cell",
"in": "query",
"description": "PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "received_dedicated_preambles_cell",
"in": "query",
"description": "Received dedicated preambles in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "received_randomly_selected_preambles_low_range_cell",
"in": "query",
"description": "Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "received_randomly_selected_preambles_high_range_cell",
"in": "query",
"description": "Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "number_of_active_ue_dl_gbr_cell",
"in": "query",
"description": "Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "number_of_active_ue_ul_gbr_cell",
"in": "query",
"description": "Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "number_of_active_ue_dl_nongbr_cell",
"in": "query",
"description": "Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "number_of_active_ue_ul_nongbr_cell",
"in": "query",
"description": "Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_gbr_pdr_cell",
"in": "query",
"description": "Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_pdr_cell",
"in": "query",
"description": "Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_pdr_cell",
"in": "query",
"description": "Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_pdr_cell",
"in": "query",
"description": "Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_gbr_delay_ue",
"in": "query",
"description": "Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_delay_ue",
"in": "query",
"description": "Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_delay_ue",
"in": "query",
"description": "Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_delay_ue",
"in": "query",
"description": "Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_gbr_pdr_ue",
"in": "query",
"description": "Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_pdr_ue",
"in": "query",
"description": "Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_pdr_ue",
"in": "query",
"description": "Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_pdr_ue",
"in": "query",
"description": "Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_gbr_throughput_ue",
"in": "query",
"description": "Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_throughput_ue",
"in": "query",
"description": "Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_throughput_ue",
"in": "query",
"description": "Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_throughput_ue",
"in": "query",
"description": "Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_gbr_data_volume_ue",
"in": "query",
"description": "Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_gbr_data_volume_ue",
"in": "query",
"description": "Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "dl_nongbr_data_volume_ue",
"in": "query",
"description": "Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
"name": "ul_nongbr_data_volume_ue",
"in": "query",