description:The present document focuses on the Multi-access Traffic Steering multi-access edge service. It describes the related application policy information including authorization and access control, information flows, required information and service aggregation patterns. The present document specifies the necessary API with the data model and data format.
summary:Retrieve information about a list of bandwidthAllocation resources.
description:This method retrieves information about a list of bandwidthAllocation resources. This method is typically used in "Get configured bandwidth allocation from Bandwidth Management Service" procedure as described in clause 6.2.5.
description:This method is used to create a bandwidthAllocation resource. This method is typically used in "Register to Bandwidth Management Service" procedure as described in clause 6.2.1.
operationId:BwallocationsPOST
tags:
-bwm
requestBody:
description:Entity body in the request contains BwInfo to be created.
description:Size of requested fixed BW allocation in [bps]
type:string
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:String
fixedBWPriority:
description:Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
description:Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected
items:
type:object
properties:
dstAddress:
description:Destination address identity of session. The string for an IPv4 address shall
be formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in
CIDR notation [12] used to provide the routing prefix
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
dstPort:
description:Destination port identity of session
items:
type:string
minItems:0
type:array
x-etsi-mec-cardinality:0..N
x-etsi-mec-origin-type:String
protocol:
description:Protocol number
items:
$ref:'#/components/schemas/SessionFilter'
fixedBWPriority:
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
sourceIp:
description:Source address identity of session. The string for an IPv4 address shall be
formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string for
an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with in CIDR
notation [12] used to provide the routing prefix
description:Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
enum:
-SEE_DESCRIPTION
fixedAllocation:
description:Size of requested fixed BW allocation in [bps]
description:Size of requested fixed BW allocation in [bps]
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:String
fixedBWPriority:
description:Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
description:Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected
type:array
items:
$ref:'#/components/schemas/SessionFilter1'
fixedBWPriority:
type:string
description:Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
enum:
-SEE_DESCRIPTION
fixedAllocation:
description:Size of requested fixed BW allocation in [bps]
description:Time stamp to indicate when the corresponding information elements are sent
type:object
properties:
seconds:
description:The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
type:integer
format:uint32
nanoSeconds:
description:The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
type:integer
format:uint32
required:
-seconds
-nanoSeconds
SessionFilter:
description:Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter, the request shall be rejected
description:Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter, the request shall be rejected
type:object
minItems:0
properties:
sourceIp:
description:Source address identity of session. The string for an IPv4 address shall be
formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11], with
in CIDR notation [12] used to provide the routing prefix
description:The present document focuses on the Multi-access Traffic Steering multi-access edge service. It describes the related application policy information including authorization and access control, information flows, required information and service aggregation patterns. The present document specifies the necessary API with the data model and data format.
description:The GET method is used to query information about the MTS information. This method is typically used in the "Get MTS service Info from the MTS Service" procedure as described in clause 6.2.6.
description:Upon success, a response body containing the MTS capability information is returned.
content:
application/json:
schema:
$ref:"#/components/schemas/MtsCapabilityInfo"
"400":
$ref:"#/components/responses/400"
"403":
type:object
properties:
MtsCapabilityInfo:
$ref:'#/components/schemas/MtsCapabilityInfo'
'400':
$ref:'#/components/responses/400'
'403':
$ref:'#/components/responses/403'
"404":
'404':
$ref:'#/components/responses/404'
/mts_sessions:
parameters:[]
/mts_sessions/{sessionId}:
get:
summary:Retrieve information about specific MTS session.
description:This method retrieves information about an individual MTS session. This method is typically used in the "Get configured MTS Session Info from the MTS Service" procedure as described in clause 6.2.10.
description:Upon success, a response body containing data type describing the updated MtsSessionInfo is returned.
content:
application/json:
schema:
$ref:"#/components/schemas/MtsSessionInfo"
"400":
$ref:"#/components/responses/400"
"403":
type:object
properties:
MtsSessionInfo:
$ref:'#/components/schemas/MtsSessionInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
"404":
'412':
$ref:'#/components/responses/412'
parameters:
-name:sessionId
in:path
required:true
description:The unique identifier of the sessionId.
schema:
type:string
delete:
summary:Remove specific MTS session.
description:DELETE method is typically used in "Unregister from the MTS Service" procedure as described in clause 6.2.8.
operationId:MtssessionsDELETESessionid
tags:
-mts
responses:
'204':
$ref:'#/components/responses/204'
'404':
$ref:'#/components/responses/404'
/mts_sessions/{sessionId}:
'403':
$ref:'#/components/responses/403'
parameters:
-name:sessionId
in:path
required:true
description:The unique identifier of the sessionId.
schema:
type:string
/mts_sessions:
get:
summary:Retrieve information about a list of MTS sessions.
description:This method retrieves information about a list of MTS sessions. This method is typically used in the "Get configured MTS Session Info from the MTS Service" procedure as described in clause 6.2.10.
description:Upon success, a response body containing an array of the MTS sessions is returned.
content:
application/json:
schema:
$ref:"#/components/schemas/MtsSessionInfo"
"400":
$ref:"#/components/responses/400"
"403":
$ref:'#/components/responses/403'
"404":
type:array
items:
$ref:'#/components/schemas/MtsSessionInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
put:
'403':
$ref:'#/components/responses/403'
post:
summary:Create a MTS session.
description:This method is used to create a MTS session. This method is typically used in "Register application to the MTS Service" procedure as described in clause 6.2.7.
description:The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
type:integer
format:uint32
minItems:1
type:array
x-etsi-mec-cardinality:1..N
x-etsi-mec-origin-type:Uint32
timeStamp:
title:timeStamp
description:Time stamp to indicate when the corresponding information elements are sent
properties:
nanoSeconds:
format:uint32
description:The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
type:integer
description:Time in nanoseconds in Unix-time since January 1, 1970, 00:00:00 UTC
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:Uint32
seconds:
description:Time in seconds in Unix-time since January 1, 1970, 00:00:00 UTC
format:uint32
type:integer
x-etsi-mec-cardinality:'1'
x-etsi-mec-origin-type:Uint32
required:
-seconds
-nanoSeconds
FlowFilter:
description:Traffic flow filtering criteria, applicable only if when requestType is set as FLOW_SPECIFIC_MTS_SESSION. Any filtering criteria shall define a single session only. In case multiple sessions match flowFilter, the request shall be rejected. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering
description:Traffic flow filtering criteria, applicable only if when requestType is set as FLOW_SPECIFIC_MTS_SESSION. Any filtering criteria shall define a single session only. In case multiple sessions match flowFilter the request shall be rejected. If the flowFilter field is included, at least one of its subfields shall be included. Any flowFilter subfield that is not included shall be ignored in traffic flow filtering
items:
type:object
properties:
dscp:
format:uint32
sourcePort:
description:'Sourceportidentityofsession'
type:integer
description:DSCP in the IPv4 header or Traffic Class in the IPv6 header
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:Uint32
format:uint32
dstIp:
description:Destination address identity of session. The string for an IPv4 address shall
be formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [10]. The string
for an IPv6 address shall be formatted according to clause 4 of IETF RFC 5952 [11],
with in CIDR notation [12] used to provide the routing prefix
description:QoS requirement description of the MTS session, applicable only if mtsMode = 4 (QoS). If the qosD field is included, at least one of its subfields shall be included. Any qosD subfield that is not included shall be ignored in Multi-access Traffic Steering (MTS)
type:object
properties:
maxJitter:
description:tolerable jitter in [10 nanoseconds]
type:integer
format:uint32
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:Uint32
minTpt:
description:minimal throughput in [kbps]
$ref:'#/components/schemas/Unit32'
type:object
maxLatency:
description:tolerable (one-way) delay in [10 nanoseconds]
type:integer
format:uint32
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:Uint32
$ref:'#/components/schemas/Unit32'
type:object
maxLoss:
description:tolerable packet loss rate in [1/10^x]