You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Here is the Swagger documentation for the Policy Engine REST API.


Figure 1. Policy Engine Interfaces


API Service

Method

Model

Sample

getConfig

POST

 

{
  "configAttributes": {},
  "configName": "string",
  "ecompname": "string",
  "policyName": "string",
  "requestID": "string",
  "unique": true
}

 

 {
  "configAttributes": {"key":"value"},
  "configName": "sample",
  "ecompname": "DCAE",
  "policyName": ".*",
  "requestID": "a7c6b20c-fb5e-11e5-86aa-5e5517507c66",
  "unique": false
}

sendEvent

POST

{
  "eventAttributes": {},
  "requestID": "string"
}

 

{
  "eventAttributes": {"cpu":"97", "memory":"65"},
  "requestID": "463247b2-fb5f-11e5-86aa-5e5517507c66"
}

pushPolicy

PUT

 

{
  "pdpGroup": "string",
  "policyName": "string",
  "policyScope": "string",
  "policyType": "string"
}
{
  "pdpGroup": "default",
  "policyName": "testPolicy",
  "policyScope": "testAPI",
  "policyType": "Base"
}

createPolicy

PUT

{
  "attributes": {},
  "configBody": "string",
  "configBodyType": "Properties",
  "configName": "string",
  "ecompName": "string",
  "policyClass": "Config",
  "policyConfigType": "Base",
  "policyDescription": "string",
  "policyName": "string",
  "policyScope": "string",
  "requestID": "string"
}

 

{
  "attributes": {"MATCHING":{"key":"value"}},
  "configBody": "test body",
  "configBodyType": "OTHER",
  "configName": "testConfig",
  "ecompName": "DCAE",
  "policyClass": "Config",
  "policyConfigType": "Base",
  "policyDescription": "Testing through REST API",
  "policyName": "testPolicy",
  "policyScope": "TestingAPI",
  "requestID": "6be5a05a-fb62-11e5-86aa-5e5517507c66"
}

updatePolicy

PUT

 

{
  "attributes": {},
  "configBody": "string",
  "configBodyType": "Properties",
  "configName": "string",
  "ecompName": "string",
  "policyClass": "Config",
  "policyConfigType": "Base",
  "policyDescription": "string",
  "policyName": "string",
  "policyScope": "string",
  "requestID": "string"
}

 

{
  "attributes": {"MATCHING":{"key":"value"}},
  "configBody": "test edit Body",
  "configBodyType": "OTHER",
  "configName": "testConfig",
  "ecompName": "DCAE",
  "policyClass": "Config",
  "policyConfigType": "Base",
  "policyDescription": "Testing through REST API",
  "policyName": "testPolicy",
  "policyScope": "TestingAPI",
  "requestID": "6be5a05a-fb62-11e5-86aa-5e5517507c66"
}
  • No labels