4 title: O-RAN-SC-DU PM Streaming
6 The O-RAN-SC E-Release provides a mechanism for Performance Measurement
10 The streaming interfaces depends on the o-ran-sc-du-hello-world.yang and
11 the schemas could be used as extension sot the VES domain 'stndDefind'.
12 The event message is send from a network-function to a SMO.
15 Copyright 2021 highstreet technologies GmbH
18 Licensed under the Apache License, Version 2.0 (the "License");
19 you may not use this file except in compliance with the License.
20 You may obtain a copy of the License at
22 http://www.apache.org/licenses/LICENSE-2.0
24 Unless required by applicable law or agreed to in writing, software
25 distributed under the License is distributed on an "AS IS" BASIS,
26 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27 See the License for the specific language governing permissions and
28 limitations under the License.
31 reference: https://jira.o-ran-sc.org/browse/OAM-234.
34 - url: https://management-service-consumer:8443/v1
35 description: The url of an event stream consumer.
37 /performance-measurement-stream:
39 description: Posts a collection of measurements.
40 summary: POST performance-measurement-stream
45 $ref: '#/components/schemas/performance-measurement-job'
46 description: Collection of measurements.
51 description: Bad Request
55 $ref: '#/components/schemas/error-response'
57 description: Unauthorized
61 $ref: '#/components/schemas/error-response'
63 description: Forbidden
67 $ref: '#/components/schemas/error-response'
69 description: Not Found
73 $ref: '#/components/schemas/error-response'
75 description: Method Not allowed
79 $ref: '#/components/schemas/error-response'
85 $ref: '#/components/schemas/error-response'
87 description: Internal Server Error
91 $ref: '#/components/schemas/error-response'
93 description: Error case.
97 $ref: '#/components/schemas/error-response'
102 Used when an API throws an error with a HTTP error response-code (3xx,
111 Explanation of the reason for the error which can be shown to a
116 More details and corrective actions related to the error which can
117 be shown to a human user.
118 documentation-reference:
121 description: URI of describing the error.
123 description: An abstract object class of a measurement.
126 - measurement-type-instance-reference
129 measurement-type-instance-reference:
132 A YANG instance identifier for a supported measurement type
133 according to the definitions in o-ran-sc-du-hello-world.yang.
135 Example for average downlink user equipment throughput per cell
136 /network-function/distributed-unit-functions[id='<id-value>']/cell[id='<id-value']/supported-measurements/performance-measurement-type[.='user-equipment-average-throughput-downlink']
138 Example for a specific slice-differentiator (here sd=12345) subcounter of average downlink user equipment throughput
139 /network-function/distributed-unit-functions[id='<id-value>']/cell[id='<id-value']/supported-measurements/performance-measurement-type[.='user-equipment-average-throughput-downlink']/supported-snssai-subcounter-instances/slice-differentiator[.=12345]";
143 description: A boolean value for the measurement.
145 description: A integer value for the measurement.
147 description: A number value for the measurement.
149 description: A string value for the measurement.
150 description: 'The value of the measurement type for its period. '
155 The unit for the measurement. If there is a unit associated to the
156 measurement the network-function MUST provide this field. It is
157 recommended to follow International System of Units (SI).
159 description: A collection of measurements.
162 $ref: '#/components/schemas/measurement'
163 performance-measurement-job:
164 description: The performance measurement job header and a collection of measurements.
175 The identifier configured by the event stream consumer within a
176 event stream provider for a performance-measurement-job.
180 description: 'The timestamp when the measurement was started. '
181 administrative-state:
183 Administrative state of an object. Indicates the permission to use
184 or prohibition against the object, imposed through the OAM services.
198 Operational state of the object. Indicates whether the associated
199 resource is installed and partially or fully operable (enabled) or
200 the associated resource is not installed or not operable (disabled).
205 A user defined label of the object. There is no function associated
206 to the user label. However, the network function stores the value
212 A job group identifier to combine several
213 performance-measurement-jobs to one logical job.
218 The interval time in seconds between the start of a measurement and
219 the end of a measurement
221 $ref: '#/components/schemas/measurements'
222 description: The collection of measurements.