A.3 Resource representation and APIs for MBMS resource configuration and monitoring
24.5483GPPNetwork Resource Management - Service Enabler Architecture Layer for Verticals (SEAL)Protocol specificationRelease 17TS
A.3.1 SU_MbmsResourceManagement API provided by SNRM-C
A.3.1.1 API URI
The CoAP URIs used in CoAP requests from SNRM-S towards the SNRM-C shall have the Resource URI structure as defined in Annex C.1.1 of 3GPP TS 24.546 [31] with the following clarifications:
– the <apiName> shall be "su-nmb-c";
– the <apiVersion> shall be "v1"; and
– the <apiSpecificSuffixes> shall be set as described in clause A.3.1.2.
A.3.1.2 Resources
A.3.1.2.1 Overview
Figure A.3.1.2.1-1: Resource URI structure of the SU_MbmsResourceManagement API provided by SNRM-C
Table A.3.1.2.1-1 provides an overview of the resources and applicable CoAP methods.
Table A.3.1.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
CoAP method |
Description |
|
MBMS Resource Configuration |
/val-services/{valServiceId}/mbms-resources/{tmgi}/configuration |
GET |
Retrieve MBMS Resource Configuration of the SNRM-C for a given VAL service and TMGI. |
|
PUT |
Create or update MBMS Resource Configuration of the SNRM-C for a given VAL service and TMGI. |
||
|
DELETE |
Delete MBMS Resource Configuration of the SNRM-C for a given VAL service and TMGI. |
||
|
MBMS Resource State |
/val-services/{valServiceId}/mbms-resources/{tmgi}/state |
GET (NOTE) |
Retrieve MBMS Resource State information for a given VAL service and TMGI. |
|
NOTE: The GET method can also be used to observe this resource. |
|||
A.3.1.2.2 Resource: MBMS Resource Configuration
A.3.1.2.2.1 Description
The MBMS Resource Configuration resource allows a SNRM-S to manage the MBMS Resource Configuration of a SNRM-C.
A.3.1.2.2.2 Resource Definition
Resource URI: {apiRoot}/su-nmb-c/<apiVersion>/val-services/{valServiceId}/mbms-resources/{tmgi}/configuration
This resource shall support the resource URI variables defined in the table A.3.1.2.2.2-1.
Table A.3.1.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See Annex C.1.1 of 3GPP TS 24.546 [31]. |
|
apiVersion |
string |
See clause A.3.1.1. |
|
valServiceId |
string |
Identifier of a VAL service. |
|
tmgi |
bytes |
Identifier of the MBMS resource (Temporary Mobile Group Identity). |
A.3.1.2.2.3 Resource Standard Methods
A.3.1.2.2.3.1 GET
This operation retrieves the MBMS Resource Configuration.
This method shall support the response data structures and response codes specified in table A.3.1.2.2.3.1-1.
Table A.3.1.2.2.3.1-1: Data structures supported by the GET Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
MbmsResourceConfig |
M |
1 |
2.05 Content |
The MBMS Resource Configuration information. |
|
NOTE: The mandatory CoAP error status codes for the PUT method listed in table C.1.3-1 of 3GPP TS 24.546 [31] shall also apply. |
||||
A.3.1.2.2.3.2 PUT
This operation creates and updates the MBMS Resource Configuration.
This method shall support the request data structures specified in table A.3.1.2.2.3.2-1 and the response data structures and response codes specified in table A.3.1.2.2.3.2-2.
Table A.3.1.2.2.3.2-1: Data structures supported by the PUT Request payload on this resource
|
Data type |
P |
Cardinality |
Description |
|
MbmsResourceConfig |
M |
1 |
Updated details of the MBMS Resource Configuration. |
Table A.3.1.2.2.3.2-2: Data structures supported by the PUT Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
MbmsResourceConfig |
M |
1 |
2.01 Created |
MBMS Resource Configuration created successfully. |
|
MbmsResourceConfig |
O |
1 |
2.04 Changed |
MBMS Resource Configuration updated successfully and the updated MBMS Resource Configuration may be returned in the response. |
|
NOTE: The mandatory CoAP error status codes for the PUT method listed in table C.1.3-1 of 3GPP TS 24.546 [31] shall also apply. |
||||
A.3.1.2.2.3.3 DELETE
This operation deletes the MBMS Resource Configuration.
This method shall support the response data structures and response codes specified in table A.3.1.2.2.3.3-1.
Table A.3.1.2.2.3.3-1: Data structures supported by the DELETE Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
2.02 Deleted |
MBMS Resource Configuration is deleted. |
||
|
NOTE: The mandatory CoAP error status codes for the DELETE method listed in table C.1.3-1 of 3GPP TS 24.546 [31] shall also apply. |
||||
A.3.1.2.3 Resource: MBMS Resource State
A.3.1.2.3.1 Description
The MBMS Resource State resource allows the SNRM-S to retrieve and monitor the state of the MBMS Resource as seen by the SNRM-C.
A.3.1.2.3.2 Resource Definition
Resource URI: {apiRoot}/su-nmb-c/<apiVersion>/val-services/{valServiceId}/mbms-resources/{tmgi}/state
This resource shall support the resource URI variables defined in the table A.3.1.2.3.2-1.
Table A.3.1.2.3.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See Annex C.1.1 of 3GPP TS 24.546 [31]. |
|
apiVersion |
string |
See clause A.3.1.1. |
|
valServiceId |
string |
Identifier of a VAL service. |
|
tmgi |
bytes |
Identifier of the MBMS resource (Temporary Mobile Group Identity). |
A.3.1.2.3.3 Resource Standard Methods
A.3.1.2.3.3.1 GET
This operation retrieves the MBMS resource state information as seen by the SNRM-C.
This method shall support the request options specified in table A.3.1.2.3.3-1, the response data structures and response codes specified in table A.3.1.2.3.3-2, and the response options specified in table A.3.1.2.3.3-3.
Table A.3.1.2.3.3-1: Options supported by the GET Request on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
When set to 0 (Register) it extends the GET request to subscribe to the changes of this resource. When set to 1 (Deregister) it cancels the subscription. |
|
NOTE: Other request options also apply in accordance with normal CoAP procedures. |
||||
Table A.3.1.2.3.3-2: Data structures supported by the GET Response payload on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
MbmsResourceState |
M |
1 |
2.05 Content |
MBMS resource state information at the SNRM-C. |
|
NOTE: The mandatory CoAP error status codes for the GET method listed in table C.1.3-1 of 3GPP TS 24.546 [31] also apply. |
||||
Table A.3.1.2.3.3-3: Options supported by the 2.05 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Observe |
Uinteger |
O |
0..1 |
Sequence number of the notification. |
|
NOTE: Other response options also apply in accordance with normal CoAP procedures. |
||||
A.3.1.3 Data Model
A.3.1.3.1 General
This clause specifies the application data model supported by the API. Data types listed in clause C.1.4 of TS 24.546 [31] apply to this API.
Table A.3.1.3.1-1 specifies the data types defined specifically for the SU_MbmsResourceManagement API service.
Table A.2.1.3.1-1: SU_MbmsResourceManagement API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
MbmsResourceConfig |
A.3.1.3.2.1 |
Represents the MBMS Resource configuration of the SNRM-C. |
|
|
MbmsResourceMonitoringConfig |
A.3.1.3.2.2 |
Represents the MBMS Resource monitoring configuration of the SNRM-C, i.e. instructions for the SNRM-C what to monitor in relation to the MBMS resource. |
|
|
MbmsResourceState |
A.3.1.3.2.3 |
Represents the current state of the MBMS Resource as monitored by the SNRM-C. |
Table A.3.1.3.1-2 specifies data types re-used by the SU_MbmsResourceManagement API service.
Table A.3.1.3.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
MbmsSaId |
3GPP TS 24.546 [31] |
String containing a unique identifier of a MBMS serving area. |
|
|
Tmgi |
3GPP TS 24.546 [31] |
Byte string containing an identifier of Temporary Mobile Group Identity used by the MBMS resource. |
|
|
Uinteger |
3GPP TS 24.546 [31] |
Unsigned integer. |
A.3.1.3.2 Structured data types
A.3.1.3.2.1 Type: MbmsResourceConfig
Table A.3.1.3.2.1-1: Definition of type MbmsResourceConfig
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tmgi |
Tmgi |
M |
1 |
TMGI for identifying the MBMS Resource. |
|
|
alternativeTmgis |
Array(Tmgi) |
O |
0..1 |
A list of additional alternative TMGI used in roaming scenarios. |
|
|
qci |
Uinteger |
O |
0..1 |
QCI information used by the ProSe UE-Network Relay to determine the ProSe Per-Packet Priority value to be applied for the multicast packets relayed to Remote UE over PC5. QCI values are defined in 3GPP TS 23.203 [4]. |
|
|
frequency |
Uinteger |
O |
0..1 |
Identification of frequency in case of multi carrier support. It is coded as specified in 3GPP TS 29.468 [13]. |
|
|
serviceAreas |
array(MbmsSaId) |
O |
0..N |
List of MBMS service area identifiers. |
|
|
sdp |
string |
O |
0..1 |
SDP with media and application control information applicable to groups that can use this MBMS bearer. |
|
|
rohcEnabled |
boolean |
O |
0..1 |
Indicates if the flows delivered by the MBMS bearer are header compressed with ROHC as specified in IETF RFC 5795 [20] and IETF RFC 3095 [16]. |
|
|
monitorConfig |
MbmsResourceMonitoringConfig |
O |
0..1 |
Monitoring configuration for the SNRM-C. |
A.3.1.3.2.2 Type: MbmsResourceMonitoringConfig
Table A.3.1.3.2.2-1: Definition of type MbmsResourceMonitoringConfig
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
receptionQuality |
boolean |
O |
0..1 |
Indicates if reception quality of the MBMS bearer is to be monitored. |
|
|
unicastResource |
boolean |
O |
0..1 |
Indicates if the unicast resource related to the MBMS berare is to be monitored. |
|
|
suspension |
boolean |
O |
0..1 |
Indicates if suspension state of the MBMS bearer is to be monitored. |
A.3.1.3.2.3 Type: MbmsResourceState
Table A.3.1.3.2.3-3: Definition of type MbmsResourceState
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tmgi |
Tmgi |
M |
1 |
Temprorary Mobile Group Identity for identifying the MBMS Resource. |
|
|
monitorConfig |
MbmsResourceMonitoringConfig |
M |
1 |
MBMS Resource monitoring configuration of the SNRM-C. |
|
|
receptionQualityLevel |
integer |
O |
0..1 |
Reception quality level measured for the MBMS bearer. |
|
|
suspendingState |
boolean |
O |
0..1 |
Indicates if the MBMS bearer’s intended suspension state: – "true" indicates that the RAN has decided to suspend the referenced MBMS bearer(s) at the beginning of the next MCCH modification period; – "false" indicates that the RAN has decided to revoke its decision to suspend the referenced MBMS bearer(s) before the beginning of the next MCCH modification period; |
|
|
unicastListeningState |
boolean |
O |
0..1 |
Indicate the unicast listening status: – "true" indicates that the VAL UE is listening; – "false" indicates that the VAL UE is not listening; |
A.3.1.4 Error Handling
General error responses are defined in clause C.1.3 of 3GPP TS 24.546 [31].
A.3.1.5 CDDL Specification
A.3.1.5.1 Introduction
The data model described in clause A.3.1.3 shall be binary encoded in the CBOR format as described in IETF RFC 8949 [26].
Clause A.3.1.5.2 uses the Concise Data Definition Language described in IETF RFC 8610 [28] and provides corresponding representation of the SU_MbmsResourceManagement API provided by SNRM-C data model.
A.3.1.5.2 CDDL document
;;; MbmsResourceConfig
;;+ Represents MBMS resource configuration.
MbmsResourceConfig = {
tmgi: Tmgi
? alternativeTmgis: [+ Tmgi]
? qci: Uinteger
? frequency: Uinteger
? serviceAreas: [+ MbmsSaId]
? sdp: text
? rohcEnabled: bool
? monitorConfig: MbmsResourceMonitoringConfig
}
;;; MbmsResourceMonitoringConfig
;;+ Represents MBMS resource monitoring configuration, i.e. instructions for the VAL UE what to monitor in relation to the MBMS resource.
MbmsResourceMonitoringConfig = {
? receptionQuality: bool
? unicastResource: bool
? suspension: bool
}
;;; MbmsResourceState
;;+ Represents MBMS Resource state information as observed by the VAL UE.
MbmsResourceState = {
tmgi: Tmgi
monitoringConfig: MbmsResourceMonitoringConfig
? receptionQualityLevel: int
? suspendingState: bool
? unicastListeningState: bool
}
;;; MbmsSaId
;;+ Unique identifier of a MBMS serving area.
MbmsSaId = text
;;; Tmgi
;;+ Temprorary Mobile Group Identity for use by MBMS.
Tmgi = bytes
;;; Uinteger
;;+ Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.
Uinteger = int .ge 0
A.3.1.6 Media Types
The media type for a MBMS Resource Configuration shall be "application/vnd.3gpp.seal-mbms-config+cbor".
The media type for a MBMS Resource State shall be "application/vnd.3gpp.seal-mbms-state+cbor".
A.3.1.7 Media Type registration for application/vnd.3gpp.seal-mbms-config+cbor
Type name: application
Subtype name: vnd.3gpp.seal-mbms-config+cbor
Required parameters: none
Optional parameters: none
Encoding considerations: Must be encoded as using IETF RFC 8949 [17]. See "MbmsResourceConfig" data type in 3GPP TS 24.548 clause A.3.1.3.2.1 for details.
Security considerations: See Section 10 of IETF RFC 8949 [17] and Section 11 of IETF RFC 7252 [23].
Interoperability considerations: Applications must ignore any key-value pairs that they do not understand. This allows backwards-compatible extensions to this specification.
Published specification: 3GPP TS 24.548 "Network Resource Management – Service Enabler Architecture Layer for Verticals (SEAL); Protocol specification", available via http://www.3gpp.org/specs/numbering.htm.
Applications that use this media type: Applications supporting the SEAL network resource management procedures as described in the published specification.
Fragment identifier considerations: Fragment identification is the same as specified for "application/cbor" media type in IETF RFC 8949 [17]. Note that currently that RFC does not define fragmentation identification syntax for "application/cbor".
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): none
Macintosh file type code(s): none
Person & email address to contact for further information: <MCC name>, <MCC email address>
Intended usage: COMMON
Restrictions on usage: None
Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
Change controller: <MCC name>/<MCC email address>
A.3.1.8 Media Type registration for application/vnd.3gpp.seal-mbms-state+cbor
Type name: application
Subtype name: vnd.3gpp.seal-mbms-state+cbor
Required parameters: none
Optional parameters: none
Encoding considerations: Must be encoded as using IETF RFC 8949 [17]. See "MbmsResourceState" data type in 3GPP TS 24.548 clause A.3.1.3.2.3 for details.
Security considerations: See Section 10 of IETF RFC 8949 [17] and Section 11 of IETF RFC 7252 [23].
Interoperability considerations: Applications must ignore any key-value pairs that they do not understand. This allows backwards-compatible extensions to this specification.
Published specification: 3GPP TS 24.548 "Network Resource Management – Service Enabler Architecture Layer for Verticals (SEAL); Protocol specification", available via http://www.3gpp.org/specs/numbering.htm.
Applications that use this media type: Applications supporting the SEAL network resource management procedures as described in the published specification.
Fragment identifier considerations: Fragment identification is the same as specified for "application/cbor" media type in IETF RFC 8949 [17]. Note that currently that RFC does not define fragmentation identification syntax for "application/cbor".
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): none
Macintosh file type code(s): none
Person & email address to contact for further information: <MCC name>, <MCC email address>
Intended usage: COMMON
Restrictions on usage: None
Author: 3GPP CT1 Working Group/3GPP_TSG_CT_WG1@LIST.ETSI.ORG
Change controller: <MCC name>/<MCC email address>
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-10 |
CT1#120 |
C1-196358 |
Draft skeleton provided by the rapporteur. |
0.0.0 |
|||
|
2019-10 |
CT1#120 |
Implementing the following p-CRs agreed by CT1: |
0.1.0 |
||||
|
2019-11 |
CT1#121 |
Implementing the following p-CRs agreed by CT1: Corrections done by the rapporteur. |
0.2.0 |
||||
|
2020-03 |
CT1#122-e |
Implementing the following p-CRs agreed by CT1: Corrections done by the rapporteur. |
0.3.0 |
||||
|
2020-03 |
CT-87e |
CP-200172 |
Presentation to TSG CT for information |
||||
|
2020-04 |
CT1#123-e |
Implementing the following p-CRs agreed by CT1: Corrections done by the rapporteur. |
1.1.0 |
||||
|
2020-06 |
CT1#124-e |
Implementing the following p-CRs agreed by CT1: Corrections done by the rapporteur. |
1.2.0 |
||||
|
2020-06 |
CT-88e |
Presentation to TSG CT for approval |
2.0.0 |
||||
|
2020-06 |
CT-88e |
Version 16.0.0 created after approval |
16.0.0 |
||||
|
2020-09 |
CT-89e |
CP-202163 |
0001 |
F |
Miscellaneous editorial corrections |
16.1.0 |
|
|
2020-09 |
CT-89e |
CP-202163 |
0002 |
F |
Correction to identity element of MBMS bearers request |
16.1.0 |
|
|
2020-09 |
CT-89e |
CP-202163 |
0003 |
1 |
F |
Updates to MBMS bear quality detection procedure |
16.1.0 |
|
2020-09 |
CT-89e |
CP-202163 |
0004 |
1 |
F |
Updates to user plane delivery mode |
16.1.0 |
|
2020-12 |
CT-90e |
CP-203210 |
0005 |
F |
Remove the protection type in the XML schema |
16.2.0 |
|
|
2020-12 |
CT-90e |
CP-203210 |
0006 |
1 |
F |
Correction of SNRM-C requirements |
16.2.0 |
|
2021-03 |
CT-91e |
CP-210111 |
0008 |
F |
Resolution of editor’s note under clause 7 |
16.3.0 |
|
|
2021-12 |
CT-94e |
CP-213052 |
0009 |
1 |
B |
Procedure for network assisted QoS management |
17.0.0 |
|
2021-12 |
CT-94e |
CP-213052 |
0010 |
– |
B |
Info document for network assisted QoS management |
17.0.0 |
|
2021-12 |
CT-94e |
CP-213052 |
0011 |
– |
B |
IANA registration for NetworkQoSManagementInfo |
17.0.0 |
|
2021-12 |
CT-94e |
CP-213052 |
0012 |
1 |
B |
XML schema and MIME type for network assisted QoS management |
17.0.0 |
|
2021-12 |
CT-94e |
CP-213031 |
0013 |
– |
B |
Reference update for HTTP/1.1 protocol |
17.0.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0014 |
– |
B |
Addition of Functional entities for CoAP |
17.1.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0015 |
– |
B |
Addition of Authenticated identity for CoAP |
17.1.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0016 |
– |
B |
Addition of CoAP for Network assisted QoS management provisioning |
17.1.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0017 |
– |
B |
Addition of CoAP for Network assisted QoS management initiation |
17.1.0 |
|
2022-06 |
CT-96 |
CP-221217 |
0018 |
– |
B |
Addition of CoAP resource representation and encoding annex |
17.1.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0021 |
– |
B |
Addition of CoAP for MBMS bearer announcement over MBMS bearer procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0019 |
1 |
F |
Minor corrections |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0020 |
1 |
B |
Addition of CoAP for use of pre-established MBMS bearers procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0022 |
– |
B |
Addition of CoAP for MBMS bearer quality detection procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0023 |
– |
B |
Addition of CoAP for Service continuity in MBMS scenarios |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0024 |
– |
B |
Addition of CoAP for MBMS suspension notification procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0025 |
– |
B |
Addition of CoAP for Switching between MBMS bearer bearer and unicast bearer procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0026 |
– |
B |
Addition of CoAP for Use of dynamic MBMS bearers procedure |
17.2.0 |
|
2022-09 |
CT-97e |
CP-222150 |
0027 |
1 |
B |
Addition of resource representation and API annex |
17.2.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0028 |
1 |
F |
Update usages of MBMS XML schema. |
17.3.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0029 |
1 |
F |
Update usages of TMGI XML element |
17.3.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0030 |
1 |
F |
Resolution of editor’s note in A.2.1.2.1 |
17.3.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0031 |
1 |
F |
Resolution of editor’s note in A.2.1.6 and A.3.1.6 |
17.3.0 |
|
2022-12 |
CT-98e |
CP-223123 |
0033 |
2 |
F |
Update incorrect reference numbers |
17.3.0 |