Versions Compared

Key

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

...

The following APIs are used to support the above looking up.

Status Update

Code Block
languagetext
titleQuery service instances by connectivity Create/Query termination point
collapsetrue
For updating TP status.


URL: https://<AAI host>:<AAI port>/aai/v14/network/connectivities/connectivity/{connectivityId/pnfs/pnf/{pnfName}/p-interfaces/p-interface/{tp-id}
Method: GetPUT
Response Request Body:
{
...
"access-ltp-id    "interface-name":"ltp {tp-id}",
...
"relationship-list":{
    "relationshipnetwork-ref" : ["some network",
    "transparent" : "some {value",
    "speed-value" : "eth bandwidth",
    "relatedoperational-tostatus" : "service-instance",
     some status",
    "relationship-list" : { 
      "related-linkrelationship" : "url of service-instance",[
           "relationship-data": [
{
                "relationshiprelated-keyto" : "service-instance.service-instance-idvpn-binding",
                "relationshiprelated-valuelink" : "some id"
url of vpn-binding",
             ]
   "relationship-data" : [
  },
       {
           "relatedrelationship-tokey" : "",vpn-binding.vpn-id",
                    "relatedrelationship-linkvalue" : "url of vpn-binding",some-id"
           "relationship-data": [
               "relationship-key" : "vpn-binding.vpn-binding-id",]
              "relationship-value": "some id"}
            ]
       }
}
      ]
   }
}
Code Block
languagetext
titleCreate/Query termination point
collapsetrue
For updating TP status.For query by TP & Status:


URL: https://<AAI host>:<AAI port>/aai/v14/network/pnfs/pnf/{pnfName}/p-interfaces/p-interface/{tp-id}
Method: PUTGET


Request Body :
{
}


Response body:
{
    "interface-name":"{tp-id}",
    "network-ref" : "some network",
    "transparent" : "some value",
    "speed-value" : "eth bandwidth",
    "operational-status" : "some status",
    "relationship-list" : { 
      "relationship" : [
          {
                "related-to" : "vpn-binding",
                "related-link" : "url of vpn-binding",
                "relationship-data" : [
                    "relationship-key" : "vpn-binding.vpn-id",
                    "relationship-value" : "some-id"
                    ]
          }
        ]
      }
}


For query by TP & Status:


Service Instance ID Look Up

Code Block
languagetext
titleQuery service instances by connectivity
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/network/pnfsconnectivities/pnfconnectivity/{pnfName}/p-interfaces/p-interface/{tp-idconnectivityId}
Method: GET


RequestGet
Response  Body :
{
}


Response body:
{
    "interface-name":"{tp-id}",...
"access-ltp-id":"ltp id",
...
"relationship-list":{
    "network-refrelationship" : "some network",[
    "transparent" : "some value",{
    "speed-value" : "eth bandwidth",
    "operationalrelated-statusto" : "some statusservice-instance",
    "relationship-list" : { 
    "related-link" : "relationship"url : [of service-instance",
          {
   "relationship-data": [
              "relatedrelationship-tokey" : "vpn-bindingservice-instance.service-instance-id",
                "relatedrelationship-linkvalue" : "url of vpn-binding",
some id"
            ]
     "relationship-data" : [},
         {
           "relationshiprelated-keyto" : "",vpn-binding.vpn-id",
           "related-link" : "url of vpn-binding",
           "relationship-valuedata": [
              "relationship-key" : "somevpn-binding.vpn-binding-id",
              "relationship-value": "some id"
    ]
        ]
  }
     }
   ]
   ]
   }
}
Code Block
languagetext
titleQuery for network resources
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/network/network-resources?network-id={networkId}&provide-id={providerId}
Method: GET
Response Body:
{
   "results" :	[
       "network-resource":{
            "network-id" : "{networkId}",
            "provider-id" : "{providerId}",
            "pnfs":{....},
            "relationship-list":{
                  "relationship" : [
                     {
                        "related-to" : "vpn-binding",
                        "related-link" : "url of vpn-binding",
                        "relationship-data" : [
                             "relationship-key" : "vpn-binding.vpn-id",
                             "relationship-value" : "some-id"
                         ]
                     }
                 ]               
            }
       }
	]
}

Alarm Correlation

Code Block
languagetext
titleQuery service instances for CCVPNp-interfaces
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/businessnetwork/customerspnfs/customerpnf/{global-custoner-idpnfName}/service-subscriptions/service-subscription/{service-type}/service-instances?service-instance-id={serviceIdp-interfaces?interface-name={ifName}&operational-status={status}
Method: GET
RequestResquest Body:
{
}


Response Body:
{    
	"service-instance-idresults" : "{service-instance-id}",[
		{
        "servicep-instance-nameinterface" : {
   "instance name",
	"service-type          "interface-name":{ifName}",                  
			 "network-ref": "some typeref",
	"service-role             "transparent": "some roleblue",
	"model-invariant-id": "model id",
	"model-version-id": "model version",
	"customer-request:"request parameters",  // ... This is the service instance recreation input looked up by CL.
	"resource-version": "some version"
}


Example of response body:
{
	"service-instance-id": "176d9eba-1662-4289-8396-0097b50fd485",
	"service-type": "E2E Service",
	"service-role": "E2E Service",
	"model-invariant-id": "c22a9483-d2b6-49cc-b1f7-ef34c93572a1",
	"model-version-id": "71d0e396-e246-4c23-aa57-6da2043d6209",
	"customer-request:".....;",                  "operational-status":"some speed",
             "speed-value" : "some speed",
             "relationship-list":
                "relationship" : [
                    {
        // ... This is the service instance recreation input looked   up by CL.
	"resourcerelated-versionto" : "1528975017336"
	"relationship-list": {logic-link",
    	 "relationship": [
          	{
          	"related-tolink" : "pnf'url of logical-link",
          	"related-link": "/aai/v11/network/pnfs/pnf/MME-0001",
            	"relationship-data": [
     				{     
                	"relationship-key" : "pnf.pnf-idlogical-link.link.name",
       
                   	"relationship-value":; "176d9eba-1662-4289-8396-0097b50fd466some name"
    				}
                  			],
          	"related-to-property": [
					{
					"property-key": "pnf.pnf-name",          },
               
					"property-value": "MME-0001"
    				}{
    			]
     			}  
		]
	}
}

Code Block
languagetext
titleQuery for Logical-links
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/network/logical-links?link-name={linkName}&operational-status={status}
Method: GET
{
}

Response Body:
{
"results": [
             "logicrelated-linksto" : {"pnf",
       "link-name" : "{linkName}",
      "operational-status": "{status}",
      "modelrelated-invariant-idlink" :'url "someof invariantpnf",
      "model-version-id"  : "some version",
      "link-id":"some id",
      "relationship-listdata"  : [
              {
            "relationship-key" : ["pnf.pnf.name",
                {
                     "related-to": "p-interface","relationship-value"; "some name"
                     "related-link": "url of p-interface 1",
 ]
                    }
    "relationship-data":[
          ]
           } 
    "relationship-key" : "p-interface.interface-name",
                          "relationship-value" : "some name 1"
                      ]
                }
]
}

Look up for 'input-parameters' by 'service-instance-id'


Code Block
languagetext
titleQuery service instances for CCVPN
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/business/customers/customer/{global-custoner-id}/service-subscriptions/service-subscription/{service-type}/service-instances?service-instance-id={serviceId}
Method: GET
Request Body:
{
}
Response Body:
{
	"service-instance-id": "{service-instance-id}",
    "service-instance-name" : "instance name",
	"service-type": "some type",
	"service-role": "some role",
	"model-invariant-id": "model id",
	"model-version-id": "model version",
	"customer-request:"request parameters",  // ... This is the service instance recreation input looked up by CL.
	"resource-version": "some version"
}


Example of response body:
{
	"service-instance-id": "176d9eba-1662-4289-8396-0097b50fd485",
	"service-type": "E2E Service",
	"service-role": "E2E Service",
	"model-invariant-id": "c22a9483-d2b6-49cc-b1f7-ef34c93572a1",
	"model-version-id": "71d0e396-e246-4c23-aa57-6da2043d6209",
	"customer-request:".....;",             ],  
           },
          // ... This is the service instance recreation input looked up by CL.
	"resource-version": "1528975017336"
	"relationship-list": {
            	 "relationship" : [
                	{
                     	"related-to": "p-interface",
                     "related-link": "url of p-interface 2 "pnf",
          	"related-link": "/aai/v11/network/pnfs/pnf/MME-0001",
          	"relationship-data": [
    				{     
                 	"relationship-key" : "p-interfacepnf.interfacepnf-nameid",
       
                   	"relationship-value" : "some name 2176d9eba-1662-4289-8396-0097b50fd466"
    				}
    			],
              ]
  	"related-to-property": [
					{
					"property-key": "pnf.pnf-name",       
					"property-value": "MME-0001"
      				}
               ],  
            }    
      ]
 			]
  			}  
		]
	}
}

Others

Code Block
languagetext
titleQuery for pLogical-interfaceslinks
collapsetrue
URL: https://<AAI host>:<AAI port>/aai/v14/network/pnfs/pnf/{pnfName}/p-interfaces?interfacelogical-links?link-name={ifNamelinkName}&operational-status={status}
Method: GET
Resquest Body:
{
}


Response Body:
{    
	"results" : [
		{
        "plogic-interfacelinks" : {
             "interfacelink-name" : "{ifNamelinkName}",
        "operational-status": "{status}",
          
			 "network-ref"model-invariant-id": "some refinvariant",
           "model-version-id"  "transparent": "some blueversion",
             "operational-status"link-id":"some speedid",
             "speedrelationship-valuelist"  : "some speed",[
             "relationship-list":
 {
               "relationship" : [
                    {
                      "related-to" : "logicp-linkinterface",
                      "related-link": :'"url of logical-linkp-interface 1",
                      "relationship-data":[
                          "relationship-key" : "logicalp-linkinterface.link.interface-name",
                          "relationship-value"; : "some name 1"
                      ]
                }
             ],  
           },
           {
            "relationship" : [
                {
                      "related-to" : "pnfp-interface",
                      "related-link": :'"url of pnfp-interface 2",
                      "relationship-data":[
                          "relationship-key" : "pnf.pnf.p-interface.interface-name",
                          "relationship-value"; : "some name 2"
                      ]
                }
    }
           ],  
 ]
           }    
      ]
 }