...
The schema for the decision API is defined below.
*** some sections/fields are optional, we need to mark these ***
REDO
3.4.2 Decision API Queries
...
| Code Block |
|---|
| title | Decision API Call - Policy ID |
|---|
| linenumbers | true |
|---|
|
{
"ONAPName": "DCAE",
"ONAPComponent": "PolicyHandler",
"ONAPInstance": "UUID",
"action": "configure",
"resource": {
"policy-id": "onap.scaleout.tca"
}
} |
| Code Block |
|---|
| language | js |
|---|
| title | Decision Response - Single Policy ID query |
|---|
| linenumbers | true |
|---|
|
{
"policies": {
"onap.scaleout.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.0",
"metadata": {
"policy-id": "onap.scaleout.tca",
"policy-version": 1
},
"properties": {
"tca_policy": {
"domain": "measurementsForVfScaling",
}
"metricsPerEventName": [
}
}
} |
This example below shows the JSON body of a query for a multiple policy-id's
| Code Block |
|---|
| title | Decision API Call - Policy ID |
|---|
| linenumbers | true |
|---|
|
{
"ONAPName {
"eventName": "DCAEvLoadBalancer",
"ONAPInstance "controlLoopSchemaType": "policy-handler-0VNF",
"action "policyScope": "configuretype=configuration",
"resource": {
"policy-id": [
"onap.vcpe "policyName": "onap.scaleout.tca",
"onap.modifyconfig"policyVersion": "v0.0.1",
"onap.restart"
]
}
} "thresholds": [
{
"closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
"closedLoopEventStatus": "ONSET",
"version": "1.0.2",
"fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
"thresholdValue": 500,
"direction": "LESS_OR_EQUAL",
"severity": "MAJOR"
},
{
"closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
"closedLoopEventStatus": "ONSET",
"version": "1.0.2",
"fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
"thresholdValue": 5000,
"direction": "GREATER_OR_EQUAL",
"severity": "CRITICAL"
}
]
}
]
}
}
}
}
} |
This example below shows the JSON body of a query for a multiple policy-id's
| Code Block |
|---|
| title | Decision API Call - Policy ID |
|---|
| linenumbers | true |
|---|
|
{
"ONAPName": "DCAE",
"ONAPInstance": "policy-handler-0",
"action": "configure",
"resource": {
"policy-id": [
"onap.scaleout.tca",
"onap.restart.tca"
]
}
} |
The following is the response object:
| Code Block |
|---|
| language | js |
|---|
| title | Decision Response - Single Policy ID query |
|---|
| linenumbers | true |
|---|
|
{
"policies": {
"onap.scaleout.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.0",
"metadata": {
"policy-id": "onap.scaleout.tca"
},
"properties": {
"tca_policy": {
"domain": "measurementsForVfScaling",
"metricsPerEventName": [
{
"eventName": "vLoadBalancer",
"controlLoopSchemaType": "VNF",
"policyScope": "type=configuration",
"policyName": "onap.scaleout.tca",
"policyVersion": "v0.0.1",
"thresholds": [
{
"closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
"closedLoopEventStatus": "ONSET",
"version": "1.0.2",
"fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
"thresholdValue": 500,
"direction": "LESS_OR_EQUAL",
"severity": "MAJOR"
},
{
"closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
"closedLoopEventStatus": "ONSET",
"version": "1.0.2",
"fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
"thresholdValue": 5000,
"direction": "GREATER_OR_EQUAL",
"severity": "CRITICAL"
}
]
}
]
}
}
},
"onap.restart.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.0",
"metadata": {
"policy-id": "onap.restart.tca",
"policy-version": 1
},
"properties": {
"tca_policy": {
"domain": "measurementsForVfScaling",
"metricsPerEventName": [
{
"eventName": "Measurement_vGMUX",
"controlLoopSchemaType": "VNF",
"policyScope": "DCAE",
"policyName": "DCAE.Config_tca-hi-lo",
"policyVersion": "v0.0.1",
"thresholds": [
{
"closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
|
| Code Block |
|---|
| language | js |
|---|
| title | Decision Response - Single Policy ID query |
|---|
| linenumbers | true |
|---|
|
{
"policies": {
"onap.vcpe.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.02",
"metadata": {
"policy-idfieldPath": "onap.vcpe.tca$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
"policy-versionthresholdValue": 10,
},
"direction": "EQUAL",
"propertiesseverity": {"MAJOR",
"domainclosedLoopEventStatus": "measurementsForVfScalingABATED"
}
},
"onap.modifyconfig": {
"type "closedLoopControlName": "onap.policies.monitoring.cdap.tca.hi.lo.app",
ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
"version": "1.0.02",
"metadata": {
"policy-idfieldPath": "onap.modifyconfig$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
"policy-version "thresholdValue": 10,
},
"properties": {
"domaindirection": "measurementsForVfScalingGREATER",
}
},
"onap.restart": {
"typeseverity": "onap.policies.monitoring.cdap.tca.hi.lo.appCRITICAL",
"versionclosedLoopEventStatus": "1.0.0ONSET",
"metadata": {
"policy-id": "onap.restart",}
"policy-version": 1
]
},
"properties": {]
"domain": "measurementsForVfScaling"}
}
}
}
}
|
The simple draft example below shows the JSON body of a query in which all the deployed policies for a specific policy type are returned.
...
| Code Block |
|---|
|
{
"policies":
{
"onap.scaleout.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.0",
"metadata": {
"policy-id": "onap.scaleout.tca",
"policy-version": 1
},
"properties": {
"domain": "measurementsForVfScaling"
<OMITTED FOR BREVITY>
}
}
},
{
"onap.firewallmodifyconfig.tca": {
"type": "onap.policies.monitoring.cdap.tca.hi.lo.app",
"version": "1.0.0",
"metadata": {
"policy-id": "onap.firewallmodifyconfig.tca",
"policy-version": 1
},
"properties": {
"domain": "measurementsForVfScaling"
<OMITTED FOR BREVITY>
}
}
}
} |
4. Policy Framework Internal APIs
...
