7 | Copyright © 2017 AT&T Intellectual Property.
9 | Licensed under the Creative Commons License, Attribution 4.0 Intl.
10 (the "License"); you may not use this documentation except in
11 compliance with the License.
12 | You may obtain a copy of the License at
13 | https://creativecommons.org/licenses/by/4.0/
14 | Unless required by applicable law or agreed to in writing, software
15 distributed under the License is distributed on an "AS IS" BASIS,
16 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17 implied. See the License for the specific language governing
18 permissions and limitations under the License.
19 | ECOMP and OpenECOMP are trademarks and service marks of AT&T
20 Intellectual Property.
22 \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
27 The AAI REST API provides access to the AAI active inventory graph. The
28 API is largely configured off of models and configuration files. Each
29 vertex in the graph has an API that can be called separately or, if part
30 of a tree structure, as a nested element with one or more generations
31 (parent, grandparent, etc.).
33 The edges of the graph are provisioned using a relationship list
34 construct. For PUT methods, a relationship contains the vertex type or
35 category (related-to) and a list of relationship data which captures the
36 key pieces of data required to uniquely identify the resource. On a GET
37 method, the above information and a URL are returned. The URL can be
38 used to GET all the details of that object. The URL returned is suitable
39 for retrying failed commands but should not be expected to be cacheable
40 for very long periods (e.g., the version of the URL may get deprecated
41 when the release changes).
43 Concurrency control for AAI is in place. The assumptions made for the
44 implementation are as follows:
46 - A client always gets a resource before updating through PUT or
49 - All resource updates and deletions are done via the AAI REST APIs
51 - This solution will apply to PUT and DELETE operations.
53 - The resource-version attribute is now in every container
55 - The update API is not subject to concurrency control because it is
56 only intended to be used by clients who are the definitive source of
57 truth for the attributes they are changing. An update through the
58 update API will however reset the resource-version so clients using
59 PUT and DELETE will not risk updating with stale data.
61 - The PATCH REST verb is not subject to concurrency control because it
62 is only intended to be used by clients who are the definitive source
63 of truth for the attributes they are changing. An update through the
64 update API will however reset the resource-version so clients using
65 PUT and DELETE will not risk updating with stale data.
67 How to Use this Document
68 ========================
70 When you click on the API documentation, you will see the Summary of
71 APIs broken down by namespace (e.g., cloud-infrastructure, business,
72 network, service-design-and-creation). You can search for **Tag:**
73 (matching the explicit case) to move from namespace to namespace through
76 Search for **Paths** to skip past the Summary section where there will
77 be more detail about each API. Query parameters are provided here, as
78 well as links to our error codes.
80 Search for **Schema definitions** to see the definitions of the
81 payloads. In your browser URL, you can type /#/definitions/node-name at
82 the end of the html address to skip directly to a payload definition.
84 Note that the schema definitions now contain information about the
85 delete scope of a node (also referenced in this document) and some
86 related node information (also reference in this document as Edges).
88 Once AAI has a model and configured it, the AAI development server can
89 be used to generate sample XML and JSON payloads, according to the
90 Accept header passed in the request. This is done by calling the
91 "plural" version of an API followed by the word example (e.g.,
92 /vserver/vservers/example). This returns a GET result array with one
93 entry. That single entry can be sent in a PUT request with actual data
94 (the resource-id does not need to be in the PUT payload as it is on the
100 Information that is largely guidance or aspirational will be show in
101 gray italicized text. This information should not be relied upon or
102 referenced at this point except with the understanding that it WILL
105 **Bold blue text** will be used to cover communication to our clients
106 that may not be enforced by AAI. The sources of truth (our clients)
107 populate AAI and are expected to send the correct information, having
108 applied business rules that live in the client systems.
110 Deprecation Warnings and History
111 ================================
117 - The actions/update API will be retired. Clients must switch to PATCH.
118 There is one grandfathered usage for vpe update flows which will be
121 - The edge tag query will be retired.
123 Notable attribute and/or valid value changes (generally also impacts
126 - The persona-model-id and persona-version will be replaced with
127 model-invariant-id (same value as persona-model-id) and
128 model-version-id (the UUID of the specific version of a model).
129 Persona-model-customization-id will be replaced by
130 model-customization-id.
132 - The operational-state attribute will be replaced by
133 operational-status and the only valid values will be in-service-path
134 and out-of-service-path
136 - The vpn-binding object will be split in two to reflect more than one
137 route-target per binding. The route-target will be a child of
138 vpn-binding and some attributes will move from vpn-binding to
141 - The following license related attributes will be removed from
142 generic-vnf: license-key, entitlement-assignment-group-uuid,
143 entitlement-resource-uuid, license-assignment-group-uuid, and
144 license-key-uuid due to the introduction of the entitlement and
149 - Normal impacts due to renaming or adding attributes, splitting
150 objects, etc. Please see swagger documentation for objects of
153 - In v11, clients that require lineage, children, or relationship
154 information need to subscribe to a different DMaaP topic than the
159 - The related-link will be a URI and thus not contain
160 https://{serverroot} (impacts events)
162 - Thhe related-link will be used on a PUT as the "first choice" to
163 identify the related resource. The relationship-data structure, which
164 contains the unordered set of keys, is still an acceptable way to
165 relate two objects but, *if both the relationship-data and the
166 related-link are passed, and they don't agree, the related-link will
167 be used without warning that the data is inconsistent*.
169 - The relationship-data will be ignored on PUT.
174 The API structure is composed of:
176 - The HTTP command, which indicates the operation to perform
178 - The HTTP URI, which defines what object this operation is related to
180 - The HTTP version, which MUST be 1.1
182 Available HTTP commands are:
184 - PUT: used to create or update an object
186 - DELETE: used to delete an object or a set of objects
188 - GET : used to query an object or set of objects
190 - PATCH : used to update specific fields owned by the client doing the
193 The HTTP URI is built according to this pattern:
195 https://{serverRoot}/{namespace}/{resource}
197 - (serverRoot} refers to the server base url: hostname+port+base
198 path+version. Port and base path are OPTIONAL but AAI will use port
199 8443 and base path aai. The Amsterdam release version will be v11.
201 - {namespace} refers to the API namespace. Supported namespaces are
202 cloud-infrastructure, business, service-design-and-creation, and
205 - {resource} refers to how the object is identified according to the
206 namespace specifications.
210 GET https://{hostname}:8443/aai
211 /v11/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}
213 The GET requests support a depth query parameter allowing a query to
214 stop after it has reached a certain point in the graph. This allows
215 clients to minimize the data that is returned to them. A depth=0 returns
216 the resource itself and none of its children.
221 Given AAI is largely a correlation engine among disparate inventory
222 types, AAI will accept values as they are sent, without validating the
223 format or value of the input. It is incumbent upon the source of truth
224 to provide valid information to AAI.
226 Clients should do a GET prior to a PUT and change only the data that
227 they mean to affect. The REST APIs expect the payload passed to replace
228 the resource in AAI. **This is vital in our concurrency scheme. The
229 client will be returned an opaque value per entity which needs to be
230 returned back in the PUT. AAI will reject the PUT or DELETE if the
231 opaque value doesn't match what AAI has stored for that entity.**
233 If a leaf has been added to a model in vN+1, and a GET/PUT of a vN
234 resource is done, AAI should not affect the new leaf (i.e., it should be
240 The PUT verb is used to both create and replace a resource. A given
241 resource may have child resources (e.g., customers have service
242 subscriptions; tenants have vservers and vservers have volumes).
244 The following convention will be followed:
246 If a resource is replaced and there are no tags for children, the
247 children that exist will be left alone.
249 If a resource is replaced and there are tags for children, the children
250 will be replaced by the list passed. If the list is empty, then children
253 Note that the relationship list is a type of child resource. The same
254 conventions are followed. It is especially critical to ensure that you
255 do not send an incomplete relationship list and therefore remove edges
256 in the graph. See section 5.10 for more information on relationship
262 To move towards industry standards and to make our APIs easier to use by
263 clients who own specific attributes and do not require AAI to enforce
264 concurrency control around them, the PATCH verb has been introduced.
266 - RFC Algorithm implemented JSON Merge PATCH
267 `tools.ietf.org/html/rfc7386 <https://tools.ietf.org/html/rfc7386>`__
269 - *HTTP Verb = PATCH*
271 - PATCH requires a Content-Type of "application/merge-patch+json" in
274 - PATCH does not support XML
276 - PATCH does not require a resource version to preform these
279 - Clients should only send what they wish to modify and whose value
284 PATCH \ `https://<hostname>:8443/aai/v11/network/generic-vnfs/generic-vnf/cscf0001v <https://aai-int1.test.att.com:8443/aai/v7/network/generic-vnfs/generic-vnf/cscf0001v>`__
288 "vnf-id": "cscf0001v", This key needs to be here but you cannot
291 "regional-resource-zone": null,
293 "ipv4-oam-address": "1.2.3.4"
297 This payload would result in the generic-vnf with the vnf-id = cscf0001v
298 having ipv4-oam-address set to "1.2.3.4" and regional-resource-zone
299 having its value removed from the database.
301 Referential Integrity
302 ---------------------
304 AAI is primarily a view to the relationships between customers,
305 products, services, physical and virtual components, etc. It stores just
306 the details it needs to be efficient to its tasks and knows how to get
307 more details if needed.
309 As such, a transaction sent to AAI may be refused if would break
310 referential integrity. The referential integrity rules of AAI are still
311 evolving as we understand the services and customers that will use us.
313 AAI uses a graph database on a NoSQL data store. The following are true
316 - Some vertices are exposed to the outside world through APIs, others
317 are internal to how we store the data (i.e., it may look like one
318 resource to our customers but it is expressed as more than one vertex
321 - Vertices that are internal to AAI will be deleted when the parent
322 vertex is deleted, if deletion of the parent leaves the child vertex
325 - Vertices that are exposed need to be managed using specific rules for
328 - Vertices may have more than just parent/child relationships. One
329 example is a vserver, which will be owned by a tenant and used by a
335 The following options are available as actions to be take upon deletion
338 - ERROR\_IF\_ANY\_EDGES – If the resource being deleted has any edges
339 at all, an error should be returned
341 - ERROR\_IF\_ANY\_IN\_EDGES – if the resource being deleted has any
342 edges that point IN towards it, an error should be returned
344 - THIS\_NODE\_ONLY – delete the vertex being requested by first
345 deleting its edge to other vertices, but do not delete the other
346 vertices. Note, the delete will be rejected if the deletion target
347 has DEPENDENT children (e.g., tenants that have vservers)
349 - CASCADE\_TO\_CHILDREN – cascade the delete through vertices who have
350 a parentOf relationship to the vertex being deleted, as long as the
351 vertex is orphaned by the delete of its parent
353 - ERROR\_4\_IN\_EDGES\_OR\_CASCADE – error if there are any in edges
354 and, if not, cascade to children
359 All REST APIs must be called using https.
361 The current release is configured to support BasicAuth. 2-way SSL using
362 client certificates should be configured for production deployments or
368 The following will be used for logging and interface diagnostic
371 - X-FromAppId Unique Application ID assigned to the user of these APIs
373 - X-TransactionId Unique ID that identifies an API request
375 The X-FromAppId will be assigned to each application by the AAI team.
376 The X-TransactionId must be unique to each transaction within the
377 context of an X-FromAppId.
379 OpenECOMP components that call AAI use the Java UUID class to generate
380 unique ids for X-TransactionId.
382 The Accept header should be set to either application/json or
385 +-------------------------------+---------------+
386 | Client | X-FromAppId |
387 +===============================+===============+
389 +-------------------------------+---------------+
390 | Master Service Orchestrator | MSO |
391 +-------------------------------+---------------+
392 | SDN Controller | SDNC |
393 +-------------------------------+---------------+
394 | Application Controller | APPC |
395 +-------------------------------+---------------+
397 Response Codes and Error Handling
398 ---------------------------------
400 HTTP response codes and error codes are described in the API
403 URLs Sent To and Retrieved From AAI
404 -----------------------------------
406 AAI receives URLs from clients that point back to that client in order
407 to get more details about the data sent to AAI. AAI expects the URLs
408 sent by clients (e.g., self links) to be URL encoded (UTF-8) and AAI
409 will store them unchanged.
411 URLs that AAI constructs that point to AAI resources will be returned
412 URLEncoded (UTF-8) to clients. This affects URLs in relationship lists
415 AAI expects space to be %20, and not plus(+).
417 The Relationship-List
418 ---------------------
420 The REST interface does not lend itself to creating more than
421 parent-child relationships and the backend structure of AAI is a graph.
422 A goal of AAI is to do as little coding as possible to introduce a new
423 service into the service design and creation environment.
425 To that end, we've introduced a relationship-list structure. AAI will
426 ask its clients to provide certain data in the relationship-list
429 Each relationship has a related-to attribute and a list of key/value
430 pairs. The related-to attribute identifies the node type that the
431 resource being acted on is to be related to using the data in the
432 key/value pairs. AAI will encode a set of rules for each resource type
433 to verify that only valid edges are being made. AAI will keep the name
434 of the edge itself, the directionality and cardinality, and the edge
435 attributes within its own logic.
437 If an attempt is made to add a relationship to a node that doesn't exist
438 (e.g., from a vserver to a vnf, and the vnf doesn't exist), a unique
439 message Id (3003) will be returned with a specific error code
440 (ERR.5.4.6129). Arguments will tell the client which node type was
441 missing (e.g., generic-vnf) and the key data for that node type
442 (generic-vnf.vnf-id).
444 Single relationships can be PUT to the graph in the following way:
446 https://{serverRoot}/{namespace}/{resource}
447 /relationship-list/relationship
451 https://{hostname}:8443/aai/v11/cloud-infrastructure/pservers/pserver/pserver-123456789-01/p-interfaces/p-interface/p-interface-name-123456789-01/l-interfaces/l-interface/l-interface-name-123456789-01/relationship-list/relationship
453 with a payload containing the relationship information.
457 <relationship xmlns="http://org.openecomp.aai.inventory/v11">
459 <related-to>logical-link</related-to>
463 <relationship-key>logical-link.link-name</relationship-key>
465 <relationship-value>logical-link-123456789-01</relationship-value>
473 "related-to": "logical-link",
475 "relationship-data": [
479 "relationship-key": "logical-link.link-name",
481 "relationship-value": " logical-link-123456789-01"
492 The following are the properties used for edge definitions. T is true, F
495 - From and To are the node types for the ends of the edges.
497 - EdgeLabel is the name of the label within the graph.
499 - Direction shows the direction of the edge.
501 - Multiplicity shows the multiplicity rule between two nodes. This
502 helps govern what AAI does when modifying relationships between edges
503 using the relationship REST APIs
505 - ParentOf indicates whether From is a parent of To.
507 - UsesResource specifies whether the From node uses resources of the To
508 node, to be able to view the data in the context of "what uses what".
510 - hasDelTarget specifies whether to try to delete the To node when the
511 From node is deleted.
513 - SVC-INFRA (deprecated)
515 The configuration for different edges supported by the AAI model are
516 defined in the DbEdgeRules.java class.
521 AAI supports query parameters on its indexed attributes.
523 As an example, if you wanted to GET a tenant by tenant-name, you would
526 /aai/vX/cloud-infrastructure/cloud-regions/cloud-region/cloud\_owner\_1/cloud-region\_1/tenants/tenant?tenant-name=value
528 The properties that are indexed are defined in the aai-schema.
536 The util domain is where AAI locates utility functions. There is
537 currently one utility function, echo, which serves as a ping test that
538 authenticated authorized clients can call to ensure there is
539 connectivity with AAI.
541 The URL for the echo utility is:
543 https://load-balanced-address:8443/aai/util/echo
545 If the response is unsuccessful, an error will be returned following the
548 The successful payload returns the X-FromAppId and X-TransactionId sent
551 Successful XML Response Payload
552 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
560 <messageId>INF0001</messageId>
562 <text>Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)</text>
566 <variable>XYZ</variable>
568 <variable>XYZ123</variable>
570 <variable>Successful health check:OK</variable>
572 <variable>0.0.0002</variable>
582 Successful JSON Response Payload
583 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
585 {"responseMessages": {"responseMessage": [{
587 "messageId": "INF0001",
589 "text": "Success X-FromAppId=%1 X-TransactionId=%2 (msg=%3) (rc=%4)",
591 "variables": {"variable": [
597 "Successful health check:OK",
605 Cloud Infrastructure Domain
606 ---------------------------
608 The Cloud Infrastructure domain (cloud-infrastructure) represents the
609 assets managed within a cloud infrastructure site. This includes the
610 physical servers, tenants, vservers and cloud-region.
615 The network namespace contains virtual and physical network resources as
616 well as connection resources such as physical links, logical links, etc.
621 The business namespace captures customers, service subscriptions, and
622 service instances. This domain is immature and will be evolving as
623 service design and creation starts to gel.
625 Service Design and Creation
626 ---------------------------
628 The service design and creation namespace captures data we invented
629 based on what we thought SDC would eventually provide.
631 To date, there are only five containers:
633 1. Service-capabilities capture the pairings of service to resources.
635 2. Service captures the service model instances and this will be
636 deprecated in the future as things mature
638 3. Models captures model definitions (subgraph definitions using the AAI
641 4. named-queries capture subgraph definitions that allow different data
642 to be retrieved for a given type of asset