Content for TS 23.436 Word version: 19.3.0
0…
5…
6…
8…
8.3…
8.4…
8.5…
8.6…
8.7…
8.8…
8.9…
8.10…
8.11…
8.12…
8.13…
8.14…
8.15…
8.16…
8.17…
8.18…
8.19…
9…
9.3…
9.4…
10…
A…
9 ADAE layer APIs
9.1 General
9.2 ADAE server APIs
9.2.1 General
9.2.2 ADAE server APIs
9.2.3 SS_ ADAE_VAL_performance_analytics API
9.2.4 SS_ ADAE_slice_performance_analytics API
9.2.5 SS_ ADAE_UE-to-UE_performance_analytics API
9.2.6 SS_ ADAE_location_accuracy_analytics API
9.2.7 SS_ ADAE_service_API_analytics API
9.2.8 SS_ADAE_slice_usage_pattern_analytics API
9.2.9 SS_ ADAE_edge_analytics API
9.2.10 SS_ ADAE_slice_usage_stats
9.2.11 SS_ADAE_edge_preparation_analytics API
9.2.12 SS_ADAE_server-to-server_performance_analytics API
9.2.13 SS_ADAE_collision_detection_analytics API
9.2.14 SS_ADAE_location-related_UE_group_analytics API
9.2.15 SS_ADAE_AIML_member_capability_analytics API
9.2.16 SS_ ADAE_ServiceExp API
9.2.17 SS_ ADAE_DN_energy_analytics API
...
...
9 ADAE layer APIs p. 111
9.1 General p. 111
The following ADAE capabilities are offered as APIs:
- ADAE server APIs;
- A-ADRF APIs;
- Group management server APIs;
- Location management server APIs;
- Configuration management server APIs;
- Identity management server APIs;
- Key management server APIs; and
- Network slice capability enablement APIs.
9.2 ADAE server APIs p. 112
9.2.1 General p. 112
This clause provides the APIs provided by ADAES.
9.2.2 ADAE server APIs p. 112
Table 9.2.2-1 illustrates the ADAE server APIs.
| API Name | API Operations | Known Consumer(s) | Communication Type |
|---|---|---|---|
|
SS_ | Subscribe | VAL server | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server / EES | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server / Subscriber/ API invoker | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server / SEAL server | Subscribe/ Notify |
| Notify | |||
|
SS_ | Subscribe | VAL server / EAS / EES | Subscribe/ Notify |
| Notify | |||
| Get | VAL server / EAS / EES | Request / Response | |
|
SS_ | Get | VAL server | Request / Response |
|
SS_ | Subscribe | VAL server / ECS / EES | Subscribe/ Notify |
| Notify | |||
| Get | VAL server / ECS / EES | Request / Response | |
|
SS_ | Subscribe | VAL server / LM server / UAE server, UAS application specific server | Subscribe/ Notify |
| Notify | |||
| Get | VAL server / LM server / UAE server, UAS application specific server | Request / Response | |
|
SS_ | Subscribe | LM server | Subscribe/ Notify |
| Notify | |||
| Get | LM server | Request / Response | |
|
SS_ | Subscribe | VAL server / AIMLE server | Subscribe/ Notify |
| Notify | |||
| Get | VAL server / AIMLE server | Request / Response | |
|
SS_ | Request | ADAE client | Request / Response |
| SS_ADAE_DN_energy_analytics | Get | VAL server / EAS / EES | Request / Response |
9.2.3 SS_ ADAE_VAL_performance_analytics API p. 113
9.2.3.1 General p. 113
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for VAL performance analytics and for getting notified on the result.
9.2.3.2 Subscribe p. 114
API operation name:
VAL_performance_analytics_subscribe
Description:
The consumer subscribes for VAL performance analytics.
Inputs:
See clause 8.2.4.2.
Outputs:
See clause 8.2.4.3.
See clause 8.2.2 and 8.2.3 for details of usage of this operation.
9.2.3.3 Notify p. 114
API operation name:
VAL_performance_analytics_notify
Description:
The consumer is notified by ADAES on the VAL performance analytics.
Inputs:
-
Outputs:
See clause 8.2.4.7.
See clause 8.2.2 and 8.2.3 for details of usage of this operation.
9.2.4 SS_ ADAE_slice_performance_analytics API p. 114
9.2.4.1 General p. 114
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for slice specific application performance analytics and for getting notified when analytics are derived.
9.2.4.2 Subscribe p. 114
API operation name:
slice_performance_analytics_subscribe
Description:
The consumer subscribes for slice specific performance analytics.
Inputs:
See clause 8.3.3.2.
Outputs:
See clause 8.3.3.3.
See clause 8.3.2 for details of usage of this operation.
9.2.4.3 Notify p. 114
API operation name:
slice_performance_analytics_notify
Description:
The consumer is notified by ADAES on the slice specific performance analytics.
Inputs:
-
Outputs:
See clause 8.3.3.4.
See clause 8.3.2 for details of usage of this operation.
9.2.5 SS_ ADAE_UE-to-UE_performance_analytics API p. 114
9.2.5.1 General p. 114
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for UE-to-UE session performance analytics and for getting notified when analytics are derived.
9.2.5.2 Subscribe p. 115
API operation name:
UE-to-UE performance_analytics_subscribe
Description:
The consumer subscribes for UE-to-UE performance analytics.
Inputs:
See clause 8.4.3.2.
Outputs:
See clause 8.4.3.3.
See clause 8.4.2 for details of usage of this operation.
9.2.5.3 Notify p. 115
API operation name:
UE-to-UE performance_analytics_notify
Description:
The consumer is notified by ADAES on the slice specific performance analytics.
Inputs:
-
Outputs:
See clause 8.4.3.6.
See clause 8.4.2 for details of usage of this operation.
9.2.6 SS_ ADAE_location_accuracy_analytics API p. 115
9.2.6.1 General p. 115
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for location accuracy analytics and for getting notified when analytics are derived.
9.2.6.2 Subscribe p. 115
API operation name:
Location_accuracy_analytics_subscribe
Description:
The consumer subscribes for location accuracy analytics.
Inputs:
See clause 8.5.3.2.
Outputs:
See clause 8.5.3.3.
See clause 8.5.2 for details of usage of this operation.
9.2.6.3 Notify p. 115
API operation name:
Location_accuracy_analytics_notify
Description:
The consumer is notified by ADAES on the location accuracy analytics.
Inputs:
-
Outputs:
See clause 8.5.3.6.
See clause 8.5.2 for details of usage of this operation.
9.2.7 SS_ ADAE_service_API_analytics API p. 115
9.2.7.1 General p. 115
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for service API analytics and for getting notified when analytics are derived.
9.2.7.2 Subscribe p. 116
API operation name:
Service_API_analytics_subscribe
Description:
The consumer subscribes for service API analytics.
Inputs:
See clause 8.6.3.2.
Outputs:
See clause 8.6.3.3.
See clause 8.6.2 for details of usage of this operation.
9.2.7.3 Notify p. 116
API operation name:
Service_API_analytics_notify
Description:
The consumer is notified by ADAES on the location accuracy analytics.
Inputs:
-
Outputs:
See clause 8.6.3.6.
See clause 8.6.2 for details of usage of this operation.
9.2.8 SS_ADAE_slice_usage_pattern_analytics API p. 116
9.2.8.1 General p. 116
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for slice usage pattern analytics and for getting notified when analytics are derived.
9.2.8.2 Subscribe p. 116
API operation name:
slice_usage_pattern_analytics_subscribe
Description:
The consumer subscribes for slice usage pattern analytics.
Inputs:
See clause 8.7.4.2.
Outputs:
See clause 8.7.4.3.
See clause 8.7.2 for details of usage of this operation.
9.2.8.3 Notify p. 116
API operation name:
slice_usage_pattern_analytics_notify
Description:
The consumer is notified by ADAES on the slice usage pattern analytics.
Inputs:
-
Outputs:
See clause 8.7.4.4.
See clause 8.7.2 for details of usage of this operation.
9.2.9 SS_ ADAE_edge_analytics API p. 116
9.2.9.1 General p. 116
API description:
This API enables the VAL server to communicate with the ADAE server for subscribing for edge load analytics and for getting notified when analytics are derived.
9.2.9.2 Subscribe p. 117
API operation name:
edge_analytics_subscribe
Description:
The consumer subscribes for edge load analytics.
Inputs:
See clause 8.8.3.2.
Outputs:
See clause 8.8.3.3.
See clause 8.8.2 for details of usage of this operation.
9.2.9.3 Notify p. 117
API operation name:
edge_analytics_notify
Description:
The consumer is notified by ADAES on the edge load analytics.
Inputs:
-
Outputs:
See clause 8.8.3.7.
See clause 8.8.2.1 for details of usage of this operation.
9.2.9.4 Get p. 117
API operation name:
edge_analytics_get
Description:
The consumer requests edge analytics data.
Inputs:
See clause 8.8.3.8.
Outputs:
See clause 8.8.3.9.
See clause 8.8.2.2 for details of usage of this operation.
9.2.10 SS_ ADAE_slice_usage_stats p. 117
9.2.10.1 General p. 117
API description:
This API enables the Consumer to communicate with the ADAE server for requesting and receiving slice usage statistical data.
9.2.10.2 Get p. 117
API operation name:
slice_usage_stats_get
Description:
The consumer requests and receives slice usage statistics from ADAE server.
Inputs:
See clause 8.7.4.7.
Outputs:
See clause 8.7.4.8.
See clause 8.7.3 for details of usage of this operation.
9.2.11 SS_ADAE_edge_preparation_analytics API |R19| p. 117
9.2.11.1 General p. 117
API description:
This API enables the analytics consumer (e.g., the VAL server, ECS, EES) to communicate with the ADAE server for requesting or subscribing to edge computing preparation.
9.2.11.2 Subscribe p. 118
API operation name:
edge_preparation_analytics_subscribe
Description:
The consumer subscribes for edge computing preparation analytics.
Inputs:
See clause 8.11.3.2.
Outputs:
See clause 8.11.3.3.
See clause 8.11.2.1 for details of usage of this operation.
9.2.11.3 Notify p. 118
API operation name:
edge_preparation_analytics_notify
Description:
The consumer is notified by the ADAE server on the edge computing preparation analytics.
Inputs:
-
Outputs:
See clause 8.11.3.4.
See clause 8.11.2.1 for details of usage of this operation.
9.2.11.4 Get p. 118
API operation name:
edge_preparation_analytics_get
Description:
The consumer requests edge computing preparation analytics
Inputs:
-See clause 8.11.3.7
Outputs:
See clause 8.11.3.8.
See clause 8.11.2.2 for details of usage of this operation.
9.2.12 SS_ADAE_server-to-server_performance_analytics API |R19| p. 118
9.2.12.1 General p. 118
API description:
This API enables the analytics consumer (e.g., the VAL server, EES) to communicate with the ADAE server for requesting or subscribing to server-to-server performance analytics.
9.2.12.2 Subscribe p. 118
API operation name:
server-to-server_performance_analytics_subscribe
Description:
The consumer subscribes to the ADAE server for Server-to-server performance analytics.
Inputs:
See clause 8.13.3.2.
Outputs:
See clause 8.13.3.3.
See clause 8.13.2 for details of usage of this operation.
9.2.12.3 Notify p. 118
API operation name:
server-to-server_performance_analytics_notify
Description:
The consumer is notified by the ADAE server on the Server-to-server performance analytics.
Inputs:
-
Outputs:
See clause 8.13.3.4.
See clause 8.13.2 for details of usage of this operation.
9.2.13 SS_ADAE_collision_detection_analytics API |R19| p. 119
9.2.13.1 General p. 119
API description:
This API enables the analytics consumer (e.g. VAL Server, LM Server, UAE server, UAS application specific server) to communicate with the ADAE server for requesting or subscribing to collision detection analytics.
9.2.13.2 Subscribe p. 119
API operation name:
collision_detection_analytics_subscribe
Description:
The consumer subscribes for collision detection analytics.
Inputs:
See clause 8.14.3.2.
Outputs:
See clause 8.14.3.3.
See clause 8.14.2.1 for details of usage of this operation.
9.2.13.3 Notify p. 119
API operation name:
collision_detection_analytics_notify
Description:
The consumer is notified by the ADAE server on collision detection analytics.
Inputs:
-
Outputs:
See clause 8.14.3.4.
See clause 8.14.2.1 for details of usage of this operation.
9.2.13.4 Get p. 119
API operation name:
collision_detection_analytics_get
Description:
The consumer requests collision detection analytics.
Inputs:
See clause 8.14.3.8.
Outputs:
See clause 8.14.3.9.
See clause 8.14.2.2 for details of usage of this operation.
9.2.14 SS_ADAE_location-related_UE_group_analytics API |R19| p. 119
9.2.14.1 General p. 119
API description:
This API enables the analytics consumer (e.g. LMS) to communicate with the ADAE server for requesting or subscribing to location-related UE group analytics.
9.2.14.2 Subscribe p. 119
API operation name:
location-related_UE_group_analytics_subscribe
Description:
The consumer subscribes for location-related UE group analytics.
Inputs:
See clause 8.15.3.2.
Outputs:
See clause 8.15.3.3.
See clause 8.15.2.1 for details of usage of this operation.
9.2.14.3 Notify p. 120
API operation name:
location-related_UE_group_analytics_notify
Description:
The consumer is notified by the ADAE server on location-related UE group analytics.
Inputs:
-
Outputs:
See clause 8.15.3.4.
See clause 8.15.2.1 for details of usage of this operation.
9.2.14.4 Get p. 120
API operation name:
location-related_UE_group_analytics_get
Description:
The consumer requests location-related UE group analytics.
Inputs:
-See clause 8.15.3.8
Outputs:
See clause 8.15.3.9.
See clause 8.15.2.2 for details of usage of this operation.
9.2.15 SS_ADAE_AIML_member_capability_analytics API |R19| p. 120
9.2.15.1 General p. 120
API description:
This API enables the analytics consumer (e.g. VAL Server, AIMLE Server) to communicate with the ADAE server for requesting or subscribing to application layer AIML member capability analytics.
9.2.15.2 Subscribe p. 120
API operation name:
AIML_member_capability_analytics_subscribe
Description:
The consumer subscribes for application layer AIML member capability analytics.
Inputs:
See clause 8.16.3.2.
Outputs:
See clause 8.16.3.3.
See clause 8.16.2.1 for details of usage of this operation.
9.2.15.3 Notify p. 120
API operation name:
AIML_member_capability_analytics_notify
Description:
The consumer is notified by the ADAE server on application layer AIML member capability analytics.
Inputs:
-
Outputs:
See clause 8.16.3.4.
See clause 8.16.2.1 for details of usage of this operation.
9.2.15.4 Get p. 120
API operation name:
AIML_member_capability_analytics_get
Description:
The consumer requests application layer AIML member capability analytics.
Inputs:
-See clause 8.16.3.8
Outputs:
See clause 8.16.3.9.
See clause 8.16.2.2 for details of usage of this operation.
9.2.16 SS_ ADAE_ServiceExp API |R19| p. 121
9.2.16.1 General p. 121
API description:
This API enables the ADAE client share service experience information to ADAE server.
9.2.16.2 Request p. 121
API operation name:
SS_
Description:
The consumer sends application service experience report to the server.
Inputs:
See clause 8.9.3.1.
Outputs:
See clause 8.9.3.2
See clause 8.9.2.1 for details of usage of this operation.
9.2.17 SS_ ADAE_DN_energy_analytics API |R19| p. 121
9.2.17.1 General p. 121
API description:
This API enables the VAL server to communicate with the ADAE server for requesting for DN energy efficiency/consumption analytics.
9.2.17.2 Get DN_energy_analytics p. 121
API operation name:
DN_energy_analytics_get
Description:
The consumer requests DN energy efficiency/consumption analytics.
Inputs:
See clause 8.18.3.2.
Outputs:
See clause 8.18.3.3.
See clause 8.18.2 for details of usage of this operation.
