REST APIs for CLAMP Control Loops
Commissioning API
This API is a CRUD API that allows Control Loop Type definitions created in a design environment to be commissioned on the CLAMP runtime. It has endpoints that allow Control Loop Types to be created, read, updated, and deleted.
The body of the create and update end points is a TOSCA Service/Topology template that defines the new or changed Control Loop Type. The update and delete endpoints take a reference to the Control Loop Type. The incoming TOSCA is verified and checked for referential integrity. On delete requests, a check is made to ensure that no Control Loop Instances exist for the Control Loop Type to be deleted.
Download Policy Control Loop Commissioning API Swagger
GET /onap/controlloop/v2/commission
Query details of the requested commissioned control loop definitions
Description: Queries details of the requested commissioned control loop definitions, returning all control loop details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop definition name |
string |
version |
query |
Control Loop definition version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
POST /onap/controlloop/v2/commission
Commissions control loop definitions
Description: Commissions control loop definitions, returning the commissioned control loop definition IDs
Consumes: [‘application/json’, ‘application/yaml’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Entity Body of Control Loop |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
DELETE /onap/controlloop/v2/commission
Delete a commissioned control loop
Description: Deletes a Commissioned Control Loop, returning optional error details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop definition name |
string |
version |
query |
Control Loop definition version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
204 - No Content
401 - Authentication Error
403 - Authorization Error
500 - Internal Server Error
GET /onap/controlloop/v2/commission/elements
Query details of the requested commissioned control loop element definitions
Description: Queries details of the requested commissioned control loop element definitions, returning all control loop elements’ details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop definition name |
string |
version |
query |
Control Loop definition version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
Instantiation API
The instantiation API has two functions:
Creation, Reading, Update, and Deletion of Control Loop Instances.
Instantiation and lifecycle management of Control Loop Instances on participants
The Instantiation API is used by the CLAMP GUI.
Instantiation Control Loop Instance CRUD
This sub API allows for the creation, read, update, and deletion of Control Loop Instances. The endpoints for create and update take a JSON body that describes the Control Loop Instance. The endpoints for read and delete take a Control Loop Instance ID to determine which Control Loop Instance to act on. For the delete endpoint, a check is made to ensure that the Control Loop Instance is not instantiated on participants.
A call to the update endpoint for a Control Loop Instance follow the semantics described here: 4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>.
Download Policy Control Loop Instantiation API Swagger
GET /onap/controlloop/v2/instantiation
Query details of the requested control loops
Description: Queries details of the requested control loops, returning all control loop details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop definition name |
string |
version |
query |
Control Loop definition version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
POST /onap/controlloop/v2/instantiation
Commissions control loop definitions
Description: Commissions control loop definitions, returning the control loop IDs
Consumes: [‘application/json’, ‘application/yaml’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
controlLoops |
body |
Entity Body of Control Loop |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
PUT /onap/controlloop/v2/instantiation
Updates control loop definitions
Description: Updates control loop definitions, returning the updated control loop definition IDs
Consumes: [‘application/json’, ‘application/yaml’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
controlLoops |
body |
Entity Body of Control Loop |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
DELETE /onap/controlloop/v2/instantiation
Delete a control loop
Description: Deletes a control loop, returning optional error details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop definition name |
string |
version |
query |
Control Loop definition version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
204 - No Content
401 - Authentication Error
403 - Authorization Error
500 - Internal Server Error
PUT /onap/controlloop/v2/instantiation/command
Issue a command to the requested control loops
Description: Issues a command to a control loop, ordering a state change on the control loop
Consumes: [‘application/json’, ‘application/yaml’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
command |
body |
Entity Body of control loop command |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
Instantiation Control Loop Instance Lifecycle Management
This sub API is used to manage the life cycle of Control Loop Instances. A Control Loop Instance can be in the states described here: 2.1 Control Loop Instance States <controlloop-instance-states>. Managing the life cycle of a Control Loop Instance amounts to steering the Control Loop through its states.
The sub API allows upgrades and downgrades of Control Loop Instances to be pushed to participants following the semantics described here: 4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>. When the API is used to update the participants on a Control Loop Instance, the new/upgraded/downgraded definition of the Control Loop is pushed to the participants. Note that the API asks the participants in a Control Loop Instance to perform the update, it is the responsibility of the participants to execute the update and report the result using the protocols described here: CLAMP Participants. The progress and result of an update can be monitored using the Monitoring API <monitoring-api>.
The sub API also allows a state change of a Control Loop Instance to be ordered. The required state of the Control Loop Instance is pushed to participants in a Control Loop Instance using the API. Note that the API asks the participants in a Control Loop Instance to perform the state change, it is the responsibility of the participants to execute the state change and report the result using the protocols described here: CLAMP Participants. The progress and result of a state change can be monitored using the Monitoring API <monitoring-api>.
Warning
The Swagger for the Instantiation Lifecycle Management API will appear here.
Monitoring API
The Monitoring API allows the state and statistics of Participants, Control Loop Instances and their Control Loop Elements to be monitored. This API is used by the CLAMP GUI. The API provides filtering so that specific Participants and Control Loop Instances can be retrieved. In addition, the quantity of statistical information to be returned can be scoped.
Download Policy Control Loop Monitoring API Swagger
GET /onap/controlloop/v2/monitoring/clelement
Query details of the requested cl element stats
Description: Queries details of the requested cl element stats, returning all clElement stats
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
endTime |
query |
end time |
string |
id |
query |
Control Loop element id |
string |
name |
query |
Participant name |
string |
recordCount |
query |
Record count |
integer |
startTime |
query |
start time |
string |
version |
query |
Participant version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/controlloop/v2/monitoring/clelements/controlloop
Query details of the requested cl element stats in a control loop
Description: Queries details of the requested cl element stats, returning all clElement stats
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop name |
string |
version |
query |
Control Loop version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/controlloop/v2/monitoring/participant
Query details of the requested participant stats
Description: Queries details of the requested participant stats, returning all participant stats
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
endTime |
query |
end time |
string |
name |
query |
Control Loop participant name |
string |
recordCount |
query |
Record count |
integer |
startTime |
query |
start time |
string |
version |
query |
Control Loop participant version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/controlloop/v2/monitoring/participants/controlloop
Query details of all the participant stats in a control loop
Description: Queries details of the participant stats, returning all participant stats
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
query |
Control Loop name |
string |
version |
query |
Control Loop version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
Pass Through API
This API allows information to be passed to Control Loop Elements in a control loop.
Warning
The requirements on this API are still under discussion.
Warning
The Swagger for the Pass Through API will appear here.
Participant Standalone API
This API allows a Participant to run in standalone mode and to run standalone Control Loop Elements.
Kubernetes participant can also be deployed as a standalone application and provides REST end points for onboarding helm charts to its local chart storage, installing and uninstalling of helm charts to a kubernetes cluster. It also allows to configure a remote repository in kubernetes participant for installing helm charts. User can onboard a helm chart along with the overrides yaml file, the chart gets stored in to the local chart directory of kubernetes participant. The onboarded charts can be installed, uninstalled. The GET API fetches all the available helm charts from the chart storage.
Download Policy Control Loop Participant Standalone API Swagger
DELETE /onap/k8sparticipant/helm/chart/{name}/{version}
Delete the chart
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
name |
string |
version |
path |
version |
string |
Responses
200 - OK
204 - Chart Deleted
401 - Unauthorized
403 - Forbidden
GET /onap/k8sparticipant/helm/charts
Return all Charts
Produces: [‘application/json’]
Responses
200 - chart List
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /onap/k8sparticipant/helm/install
Install the chart
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
info |
body |
info |
Responses
200 - OK
201 - chart Installed
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /onap/k8sparticipant/helm/onboard/chart
Onboard the Chart
Consumes: [‘multipart/form-data’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
chart |
formData |
file |
|
info |
formData |
string |
|
values |
body |
values |
Responses
200 - OK
201 - Chart Onboarded
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /onap/k8sparticipant/helm/repo
Configure helm repository
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
repo |
body |
repo |
Responses
200 - OK
201 - Repository added
401 - Unauthorized
403 - Forbidden
404 - Not Found
DELETE /onap/k8sparticipant/helm/uninstall/{name}/{version}
Uninstall the Chart
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
name |
string |
version |
path |
version |
string |
Responses
200 - OK
201 - chart Uninstalled
204 - No Content
401 - Unauthorized
403 - Forbidden
Participant Simulator API
This API allows a Participant Simulator to be started and run for test purposes.
Download Policy Participant Simulator API Swagger
PUT /onap/participantsim/v2/elements
Updates simulated control loop elements
Description: Updates simulated control loop elements, returning the updated control loop definition IDs
Consumes: [‘application/json’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Body of a control loop element |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/participantsim/v2/elements/{name}/{version}
Query details of the requested simulated control loop elements
Description: Queries details of the requested simulated control loop elements, returning all control loop element details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
Control loop element name |
string |
version |
path |
Control loop element version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
PUT /onap/participantsim/v2/participants
Updates simulated participants
Description: Updates simulated participants, returning the updated control loop definition IDs
Consumes: [‘application/json’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Body of a participant |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/participantsim/v2/participants/{name}/{version}
Query details of the requested simulated participants
Description: Queries details of the requested simulated participants, returning all participant details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
Participant name |
string |
version |
path |
Participant version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
End of Document