1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2020 Nordix
5 .. _sdnc-a1-controller-api:
7 .. |nbsp| unicode:: 0xA0
10 .. |nbh| unicode:: 0x2011
17 The A1 of a Near |nbh| RT |nbsp| RIC can be used through the SDNC A1 Controller.
19 Any version of the A1 API can be used. A call to the SDNC A1 Controller always contains the actual URL to the
20 Near |nbh| RT |nbsp| RIC, so here any of the supported API versions can be used. The controller just calls the provided
21 URL with the provided data.
32 /restconf/operations/A1-ADAPTER-API:getA1PolicyType
37 **Body:** (*Required*)
42 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-type>"
48 A JSON where the body tag contains the JSON object of the policy type. ::
52 "http-status": "integer",
62 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyType"
63 -H "Content-Type: application/json" -d '{
65 "near-rt-ric-url": "http://nearRtRic-sim1:8085/a1-p/policytypes/11"
76 \"$schema\": \"http://json-schema.org/draft-07/schema#\",
77 \"title\": \"Example_QoETarget_1.0.0\",
78 \"description\": \"Example QoE Target policy type\",
97 \"additionalProperties\": false,
104 \"type\": \"object\",
109 \"initialBuffering\": {
119 \"minProperties\": 1,
120 \"additionalProperties\": false
133 Creates or updates a policy instance.
136 /restconf/operations/A1-ADAPTER-API:putA1Policy
141 **Body:** (*Required*)
142 A JSON where the body tag contains the JSON object of the policy. ::
146 "near-rt-ric-url": "<url-to-near-rt-ric-to-put-policy>",
153 A JSON with the response. ::
157 "http-status": "integer"
164 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyType"
165 -H "Content-Type: application/json" -d '{
167 "near-rt-ric-url": "http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12",
171 "trigger_threshold":10,
192 Gets a policy instance.
195 /restconf/operations/A1-ADAPTER-API:getA1Policy
200 **Body:** (*Required*)
205 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-policy>"
211 A JSON where the body tag contains the JSON object of the policy. ::
215 "http-status": "integer",
225 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1Policy"
226 -H "Content-Type: application/json" -d '{
228 "near-rt-ric-url": "http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12"
239 \"blocking_rate\": 20,
241 \"trigger_threshold\": 10,
242 \"window_length\": 10
253 Deletes a policy instance.
256 /restconf/operations/A1-ADAPTER-API:deleteA1Policy
261 **Body:** (*Required*)
266 "near-rt-ric-url": "<url-to-near-rt-ric-to-delete-policy>"
272 A JSON with the response. ::
276 "http-status": "integer"
283 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:deleteA1Policy"
284 -H "Content-Type: application/json" -d '{
286 "near-rt-ric-url": "http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12"
305 Get the status of a policy instance.
308 /restconf/operations/A1-ADAPTER-API:getA1PolicyStatus
313 **Body:** (*Required*)
318 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-policy-status>"
324 A JSON where the body tag contains the JSON object with the policy status according to the API version used. ::
328 "http-status": "integer",
330 <policy-status-object>
338 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyStatus"
339 -H "Content-Type: application/json" -d '{
341 "near-rt-ric-url": "http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12/status"
352 \"instance_status\": \"IN EFFECT\",
353 \"has_been_deleted\": \"true\",
354 \"created_at\": \"Wed, 01 Apr 2020 07:45:45 GMT\"