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
38 **Body:** (*Required*)
44 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-type>"
51 A JSON where the body tag contains the JSON object of the policy type. ::
55 "http-status": "integer",
66 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyType"
67 -H "Content-Type: application/json" -d "{
69 \"near-rt-ric-url\": \"http://nearRtRic-sim1:8085/a1-p/policytypes/11\"
80 "$schema": "http://json-schema.org/draft-07/schema#",
81 "title": "Example_QoETarget_1.0.0",
82 "description": "Example QoE Target policy type",
101 "additionalProperties": false,
113 "initialBuffering": {
124 "additionalProperties": false
137 Creates or updates a policy instance.
140 /restconf/operations/A1-ADAPTER-API:putA1Policy
146 **Body:** (*Required*)
148 A JSON where the body tag contains the JSON object of the policy. ::
152 "near-rt-ric-url": "<url-to-near-rt-ric-to-put-policy>",
160 A JSON with the response. ::
164 "http-status": "integer"
172 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyType"
173 -H "Content-Type: application/json" -d "{
175 \"near-rt-ric-url\": \"http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12\",
177 \"blocking_rate\":20,
179 \"trigger_threshold\":10,
200 Gets a policy instance.
203 /restconf/operations/A1-ADAPTER-API:getA1Policy
209 **Body:** (*Required*)
215 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-policy>"
222 A JSON where the body tag contains the JSON object of the policy. ::
226 "http-status": "integer",
237 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1Policy"
238 -H "Content-Type: application/json" -d "{
240 \"near-rt-ric-url\": \"http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12\"
251 \"blocking_rate\": 20,
253 \"trigger_threshold\": 10,
254 \"window_length\": 10
265 Deletes a policy instance.
268 /restconf/operations/A1-ADAPTER-API:deleteA1Policy
274 **Body:** (*Required*)
280 "near-rt-ric-url": "<url-to-near-rt-ric-to-delete-policy>"
287 A JSON with the response. ::
291 "http-status": "integer"
299 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:deleteA1Policy"
300 -H "Content-Type: application/json" -d "{
302 \"near-rt-ric-url\": \"http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12\"
321 Get the status of a policy instance.
324 /restconf/operations/A1-ADAPTER-API:getA1PolicyStatus
330 **Body:** (*Required*)
336 "near-rt-ric-url": "<url-to-near-rt-ric-to-get-policy-status>"
343 A JSON where the body tag contains the JSON object with the policy status according to the API version used. ::
347 "http-status": "integer",
349 <policy-status-object>
358 curl -X POST "http://localhost:8282/restconf/operations/A1-ADAPTER-API:getA1PolicyStatus"
359 -H "Content-Type: application/json" -d "{
361 \"near-rt-ric-url\": \"http://nearRtRic-sim1:8085/a1-p/policytypes/11/policies/3d2157af-6a8f-4a7c-810f-38c2f824bf12/status\"
372 "instance_status": "IN EFFECT",
373 "has_been_deleted": "true",
374 "created_at": "Wed, 01 Apr 2020 07:45:45 GMT"