Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleAAI named-query request
POST /aai/search/named-query
 
{ 
	"query-parameters": { 
        "named-query": { 
            "named-query-uuid": "a93ac487-409c-4e8c-9e5f-334ae8f99087"
        } 
    }, 
    "instance-filters":{
    	"instance-filter":[ {
            "generic-vnf": { 
                "vnf-id": "de7cc3ab-0212-47df-9e64-da1c79234debzdfw1fwl01fwl02"
            }
        } ] 
    }
}
Code Block
titleAAI named-query response
Below is a sample response format. Field values are just examples. Will update to real values for vFW later.


{
    "inventory-response-item": [
        {
            "model-name": "service-instance",
            "generic-vnf": {
                "vnf-id": "de7cc3ab-0212-47df-9e64-da1c79234deb",
                "vnf-name": "ZRDM2MMEX39",
                "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
                "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                "orchestration-status": "active",
                "in-maint": false,
                "is-closed-loop-disabled": false,
                "resource-version": "1503082370097",
                "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9"
            },
            "extra-properties": {},
            "inventory-response-items": {
                "inventory-response-item": [
                    {
                        "model-name": "service-instance",
                        "service-instance": {
                            "service-instance-id": "37b8cdb7-94eb-468f-a0c2-4e3c3546578e",
                            "service-instance-name": "Changed Service Instance NAME",
                            "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                            "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9",
                            "resource-version": "1503082993532",
                            "orchestration-status": "Active"
                        },
                        "extra-properties": {},
                        "inventory-response-items": {
                            "inventory-response-item": [
                                {
                                    "model-name": "pnf",
                                    "generic-vnf": {
                                        "vnf-id": "jimmy-test",
                                        "vnf-name": "jimmy-test-vnf",
                                        "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
                                        "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                                        "orchestration-status": "active",
                                        "in-maint": false,
                                        "is-closed-loop-disabled": false,
                                        "resource-version": "1504013830207",
                                        "model-invariant-id": "862b25a1-262a-4961-bdaa-cdc55d69785a",
                                        "model-version-id": "e9f1fa7d-c839-418a-9601-03dc0d2ad687"
                                    },
                                    "extra-properties": {}
                                },
                                {
                                    "model-name": "service-instance",
                                    "generic-vnf": {
                                        "vnf-id": "jimmy-test-vnf2",
                                        "vnf-name": "jimmy-test-vnf2-named",
                                        "vnf-type": "vMME Svc Jul 14/vMME VF Jul 14 1",
                                        "service-id": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
                                        "orchestration-status": "active",
                                        "in-maint": false,
                                        "is-closed-loop-disabled": false,
                                        "resource-version": "1504014833841",
                                        "model-invariant-id": "82194af1-3c2c-485a-8f44-420e22a9eaa4",
                                        "model-version-id": "46b92144-923a-4d20-b85a-3cbd847668a9"
                                    },
                                    "extra-properties": {}
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}
Code Block
titleAPPC request
{
            	"CommonHeader": {
  		                      "TimeStamp": 14787212617141500997725298,
                     		   "APIver": "1.01",
  		  "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
  		  "RequestTrack": [],
  		    "Flags": []
  	},
      "OriginatorID	"Action": "policy.pdp01ModifyConfig",
  	"Payload": {
    	"generic-vnf.vnf-id": "fw0001vm001fw001",
    	"pg-streams": {
           "RequestID": "f889f60c-a715-48c0-801e-26428f6176b9",		"pg-stream": [
			{
          		"id": "fw_udp1",
             "SubRequestID		"is-enabled": "1true",
        	},
        	{
          		"RequestTrackid": []"fw_udp2",
          		"is-enabled": "true"
        	},
       "Flags": [] 	{
            }		"id": "fw_udp3",
            "Action		"is-enabled": "ModifyConfigtrue",
        	},
    "Payload": {
   	{
          		"id": "fw_udp4",
          		"generic-vnf.vnf-idis-enabled": "fw001vm001tg001true",
        	},
        	{
        "pg-streams  		"id": {"fw_udp5",
          		"is-enabled": "true"
        	}]
    	}
       	}
}


Code Block
titleAPPC response
ACCEPT response

{
      "pg-streamStatus": [{
        "Value": "ACCEPTED",
        "Code": "100"
    },
    "Payload": {
        "pg-streams":             "id": "{\\\"pg-streams\\\": {\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\",
                                                 \\\"is-enabled\\\": \\\"true"
                                    }, {
                                                "id": "fw_udp2",
                                                "is-enabled": "true"
                                    }, {
            \\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
        "generic-vnf.vnf-id": "fw0001vm001fw001"
    },
    "CommonHeader": {
        "TimeStamp": "1493841850199",
         "idAPIver": "fw_udp31.01",
        "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "SubrequestID": null,
        "OriginatorID": null
    }
}


SUCCESS response

{
      "Status": {
          "is-enabledValue": "trueSUCCESS",
               "Code": "400"
                     }, {
    "Payload": {
        "pg-streams":                                   "id": "fw_udp4",
                                                "is-enabled": "true"
                                    }, {
                                                "id": "fw_udp5",
                                                "is-enabled": "true""{\\\"pg-streams\\\": {\\\"pg-stream\\\":[{\\\"id\\\":\\\"fw_udp1\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp2\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp3\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp4\\\", \\\"is-enabled\\\":\\\"true\\\"},{\\\"id\\\":\\\"fw_udp5\\\", \\\"is-enabled\\\":\\\"true\\\"}]}}",
        "generic-vnf.vnf-id": "fw0001vm001fw001"
    },
    "CommonHeader": {
        "TimeStamp": "1493841850199",
         }]"APIver": "1.01",
        "RequestID": "664be3d2-6c12-4f4b-a3e7-c349acced200",
        "SubrequestID": null,
      }
     "OriginatorID": null
       }
}


Code Block
titleAPPC response
*TODO show the APPC response messages


vDNS Use Case

Code Block
titlevDNS - TCA Configuration Policy Payload
linenumberstrue
collapsetrue
tca_policy: "{
  "domain": "measurementsForVfScaling",
  "metricsPerEventName": [
    {
      "eventName": "vLoadBalancer",
      "controlLoopSchemaType": "VM",
      "policyScope": "DCAE",
      "policyName": "DCAE.Config_tca-hi-lo",
      "policyVersion": "v0.0.1",
      "thresholds": [
        {
          "closedLoopControlName": "CL-LBAL-LOW-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241AB1A",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "thresholdValue": 500,
          "direction": "LESS_OR_EQUAL",
          "severity": "MAJOR",
          "closedLoopEventStatus": "ONSET"
        },
        {
          "closedLoopControlName": "CL-LBAL-HIGH-TRAFFIC-SIG-0C5920A6-B564-8035-C878-0E814352BC2B",
          "version": "1.0.2",
          "fieldPath": "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
          "thresholdValue": 5000,
          "direction": "GREATER_OR_EQUAL",
          "severity": "CRITICAL",
          "closedLoopEventStatus": "ONSET"
        }
      ]
    }
    
  ]
 
}"

...