1 DMaaP Bus Controller REST API 1.1.0
2 ===================================
11 provides an API for OpenDCAE components which need to provision
12 underlying DMaaP technologies (Data Router and Message Router).
13 Primary clients for this API are anticipated to be the OpenDCAE
14 Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
17 Objects managed by DMaaP are deployed in a dcaeLocation which is a
18 unique identifier for an OpenStack tenant for a dcaeLayer,
19 opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
21 A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
22 DMaaP is managed by a one or more stateless DMaaP Bus
23 Controller(s), though Bus Controller relies on PGaaS for
24 persistence. Each DMaaP has a single instance of Data Router,
25 which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
26 Clients of type DR_Pub generally publish to a DR_Node that is
27 local to its dcaeLocation. Routing for a Feed is determined by
28 the dcaelocation of its DR_Sub clients.
30 A DMaaP may have many Message Router instances. Each instance is
31 deployed as an MR_Cluster. One MR_Cluster is deployed at each
32 dcaeLocation. MR_Clients generally communicate to the
33 MR_Cluster at the same dcaeLocation. Replication of messages
34 between MR_Clusters is accomplished by MR Bridge, which is
35 provioned by DMaaP Bus Controller based on Topic attributes.
37 Therefore, the role of DMaaP Bus Controller is to support other
38 DCAE infrastructure components to dynamically provision DMaaP
39 services on behalf of DMaaP clients, and to assist in any
40 management or discovery activity of its clients.
42 A convention of this API is to return JSON responses per
62 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
70 http://www.[host]:[port]/webapi
71 https://www.[host]:[port]/webapi
77 Endpoint for retreiving MR Bridge metrics
90 return BrTopic details
97 Returns array of `BrTopic` objects. If source and target query params are specified, only report on that bridge. If detail param is true, list topics names, else just a count is returned.
104 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
105 :widths: 20, 15, 10, 10, 10, 20, 30
107 mmagent | query | No | string | | |
108 detail | query | No | boolean | | |
124 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
128 .. code-block:: javascript
131 "brSource": "somestring",
132 "brTarget": "somestring",
133 "mmAgentName": "somestring",
143 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
147 .. code-block:: javascript
151 "fields": "somestring",
153 "message": "somestring"
167 update MirrorMaker details
174 replace the topic list for a specific Bridge. Use JSON Body for value to replace whitelist, but if refreshFlag param is true, simply refresh using existing whitelist.If split param is true, spread whitelist over smaller mmagents.
181 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
182 :widths: 20, 15, 10, 10, 10, 20, 30
184 mmagent | query | No | string | | |
185 refresh | query | No | boolean | | |
186 split | query | No | boolean | | |
202 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
206 .. code-block:: javascript
209 "brSource": "somestring",
210 "brTarget": "somestring",
211 "mmAgentName": "somestring",
221 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
225 .. code-block:: javascript
229 "fields": "somestring",
231 "message": "somestring"
241 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
247 POST ``/dcaeLocations``
248 -----------------------
254 return dcaeLocation details
261 Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
277 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
281 .. code-block:: javascript
285 "clli": "somestring",
286 "dcaeLayer": "somestring",
287 "dcaeLocationName": "somestring",
288 "lastMod": "2015-01-01T15:00:00.000Z",
290 "openStackAvailabilityZone": "somestring",
292 "subnet": "somestring"
301 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
305 .. code-block:: javascript
309 "fields": "somestring",
311 "message": "somestring"
318 DELETE ``/dcaeLocations/{locationName}``
319 ----------------------------------------
325 return dcaeLocation details
332 delete a dcaeLocation
339 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
340 :widths: 20, 15, 10, 10, 10, 20, 30
342 locationName | path | Yes | string | | |
358 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
362 .. code-block:: javascript
366 "clli": "somestring",
367 "dcaeLayer": "somestring",
368 "dcaeLocationName": "somestring",
369 "lastMod": "2015-01-01T15:00:00.000Z",
371 "openStackAvailabilityZone": "somestring",
373 "subnet": "somestring"
382 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
386 .. code-block:: javascript
390 "clli": "somestring",
391 "dcaeLayer": "somestring",
392 "dcaeLocationName": "somestring",
393 "lastMod": "2015-01-01T15:00:00.000Z",
395 "openStackAvailabilityZone": "somestring",
397 "subnet": "somestring"
406 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
410 .. code-block:: javascript
414 "fields": "somestring",
416 "message": "somestring"
423 GET ``/dcaeLocations/{locationName}``
424 -------------------------------------
430 return dcaeLocation details
437 Returns a specific `dcaeLocation` object with specified tag
444 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
445 :widths: 20, 15, 10, 10, 10, 20, 30
447 locationName | path | Yes | string | | |
463 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
467 .. code-block:: javascript
471 "clli": "somestring",
472 "dcaeLayer": "somestring",
473 "dcaeLocationName": "somestring",
474 "lastMod": "2015-01-01T15:00:00.000Z",
476 "openStackAvailabilityZone": "somestring",
478 "subnet": "somestring"
487 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
491 .. code-block:: javascript
495 "fields": "somestring",
497 "message": "somestring"
504 GET ``/dcaeLocations``
505 ----------------------
511 return dcaeLocation details
518 Returns array of `dcaeLocation` objects. All objects managed by DMaaP are deployed in some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
534 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
538 .. code-block:: javascript
542 "clli": "somestring",
543 "dcaeLayer": "somestring",
544 "dcaeLocationName": "somestring",
545 "lastMod": "2015-01-01T15:00:00.000Z",
547 "openStackAvailabilityZone": "somestring",
549 "subnet": "somestring"
558 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
562 .. code-block:: javascript
566 "fields": "somestring",
568 "message": "somestring"
575 PUT ``/dcaeLocations/{locationName}``
576 -------------------------------------
582 return dcaeLocation details
589 update the openStackAvailabilityZone of a dcaeLocation
596 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
597 :widths: 20, 15, 10, 10, 10, 20, 30
599 locationName | path | Yes | string | | |
615 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
619 .. code-block:: javascript
623 "clli": "somestring",
624 "dcaeLayer": "somestring",
625 "dcaeLocationName": "somestring",
626 "lastMod": "2015-01-01T15:00:00.000Z",
628 "openStackAvailabilityZone": "somestring",
630 "subnet": "somestring"
639 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
643 .. code-block:: javascript
647 "fields": "somestring",
649 "message": "somestring"
659 V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
679 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
695 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
699 .. code-block:: javascript
702 "accessKeyOwner": "somestring",
703 "bridgeAdminTopic": "somestring",
704 "dmaapName": "somestring",
705 "drProvUrl": "somestring",
706 "lastMod": "2015-01-01T15:00:00.000Z",
707 "loggingUrl": "somestring",
708 "nodeKey": "somestring",
710 "topicNsRoot": "somestring",
711 "version": "somestring"
720 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
724 .. code-block:: javascript
728 "fields": "somestring",
730 "message": "somestring"
751 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
767 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
771 .. code-block:: javascript
774 "accessKeyOwner": "somestring",
775 "bridgeAdminTopic": "somestring",
776 "dmaapName": "somestring",
777 "drProvUrl": "somestring",
778 "lastMod": "2015-01-01T15:00:00.000Z",
779 "loggingUrl": "somestring",
780 "nodeKey": "somestring",
782 "topicNsRoot": "somestring",
783 "version": "somestring"
792 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
796 .. code-block:: javascript
800 "fields": "somestring",
802 "message": "somestring"
823 returns the `dmaap` object, which contains system wide configuration settings
839 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
843 .. code-block:: javascript
846 "accessKeyOwner": "somestring",
847 "bridgeAdminTopic": "somestring",
848 "dmaapName": "somestring",
849 "drProvUrl": "somestring",
850 "lastMod": "2015-01-01T15:00:00.000Z",
851 "loggingUrl": "somestring",
852 "nodeKey": "somestring",
854 "topicNsRoot": "somestring",
855 "version": "somestring"
864 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
868 .. code-block:: javascript
872 "fields": "somestring",
874 "message": "somestring"
895 returns the `dmaap` object, which contains system wide configuration settings
911 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
915 .. code-block:: javascript
918 "accessKeyOwner": "somestring",
919 "bridgeAdminTopic": "somestring",
920 "dmaapName": "somestring",
921 "drProvUrl": "somestring",
922 "lastMod": "2015-01-01T15:00:00.000Z",
923 "loggingUrl": "somestring",
924 "nodeKey": "somestring",
926 "topicNsRoot": "somestring",
927 "version": "somestring"
936 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
940 .. code-block:: javascript
944 "fields": "somestring",
946 "message": "somestring"
967 Update system settings for *dcaeEnvironment*.
983 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
987 .. code-block:: javascript
990 "accessKeyOwner": "somestring",
991 "bridgeAdminTopic": "somestring",
992 "dmaapName": "somestring",
993 "drProvUrl": "somestring",
994 "lastMod": "2015-01-01T15:00:00.000Z",
995 "loggingUrl": "somestring",
996 "nodeKey": "somestring",
998 "topicNsRoot": "somestring",
999 "version": "somestring"
1008 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1012 .. code-block:: javascript
1016 "fields": "somestring",
1018 "message": "somestring"
1032 return dmaap details
1039 Update system settings for *dcaeEnvironment*.
1055 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1059 .. code-block:: javascript
1062 "accessKeyOwner": "somestring",
1063 "bridgeAdminTopic": "somestring",
1064 "dmaapName": "somestring",
1065 "drProvUrl": "somestring",
1066 "lastMod": "2015-01-01T15:00:00.000Z",
1067 "loggingUrl": "somestring",
1068 "nodeKey": "somestring",
1070 "topicNsRoot": "somestring",
1071 "version": "somestring"
1080 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1084 .. code-block:: javascript
1088 "fields": "somestring",
1090 "message": "somestring"
1100 Endpoint for a Data Router Node server
1113 return DR_Node details
1120 create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
1136 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1140 .. code-block:: javascript
1143 "dcaeLocationName": "somestring",
1144 "fqdn": "somestring",
1145 "hostName": "somestring",
1146 "lastMod": "2015-01-01T15:00:00.000Z",
1148 "version": "somestring"
1157 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1161 .. code-block:: javascript
1165 "fields": "somestring",
1167 "message": "somestring"
1174 DELETE ``/dr_nodes/{fqdn}``
1175 ---------------------------
1188 Delete a single `DR_Node` object.
1195 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1196 :widths: 20, 15, 10, 10, 10, 20, 30
1198 fqdn | path | Yes | string | | |
1211 successful operation
1214 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1218 .. code-block:: javascript
1221 "dcaeLocationName": "somestring",
1222 "fqdn": "somestring",
1223 "hostName": "somestring",
1224 "lastMod": "2015-01-01T15:00:00.000Z",
1226 "version": "somestring"
1235 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1239 .. code-block:: javascript
1242 "dcaeLocationName": "somestring",
1243 "fqdn": "somestring",
1244 "hostName": "somestring",
1245 "lastMod": "2015-01-01T15:00:00.000Z",
1247 "version": "somestring"
1256 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1260 .. code-block:: javascript
1264 "fields": "somestring",
1266 "message": "somestring"
1273 GET ``/dr_nodes/{fqdn}``
1274 ------------------------
1280 return DR_Node details
1287 Retrieve a single `DR_Node` object.
1294 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1295 :widths: 20, 15, 10, 10, 10, 20, 30
1297 fqdn | path | Yes | string | | |
1313 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1317 .. code-block:: javascript
1320 "dcaeLocationName": "somestring",
1321 "fqdn": "somestring",
1322 "hostName": "somestring",
1323 "lastMod": "2015-01-01T15:00:00.000Z",
1325 "version": "somestring"
1334 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1338 .. code-block:: javascript
1342 "fields": "somestring",
1344 "message": "somestring"
1358 return DR_Node details
1365 Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
1381 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1385 .. code-block:: javascript
1388 "dcaeLocationName": "somestring",
1389 "fqdn": "somestring",
1390 "hostName": "somestring",
1391 "lastMod": "2015-01-01T15:00:00.000Z",
1393 "version": "somestring"
1402 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1406 .. code-block:: javascript
1410 "fields": "somestring",
1412 "message": "somestring"
1419 PUT ``/dr_nodes/{fqdn}``
1420 ------------------------
1426 return DR_Node details
1433 Update a single `DR_Node` object.
1440 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1441 :widths: 20, 15, 10, 10, 10, 20, 30
1443 fqdn | path | Yes | string | | |
1459 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1463 .. code-block:: javascript
1466 "dcaeLocationName": "somestring",
1467 "fqdn": "somestring",
1468 "hostName": "somestring",
1469 "lastMod": "2015-01-01T15:00:00.000Z",
1471 "version": "somestring"
1480 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1484 .. code-block:: javascript
1488 "fields": "somestring",
1490 "message": "somestring"
1500 Endpoint for a Data Router client that implements a Publisher
1513 return DR_Pub details
1520 create a DR Publisher in the specified environment.
1536 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1540 .. code-block:: javascript
1543 "dcaeLocationName": "somestring",
1544 "feedId": "somestring",
1545 "lastMod": "2015-01-01T15:00:00.000Z",
1546 "pubId": "somestring",
1548 "username": "somestring",
1549 "userpwd": "somestring"
1558 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1562 .. code-block:: javascript
1566 "fields": "somestring",
1568 "message": "somestring"
1575 DELETE ``/dr_pubs/{pubId}``
1576 ---------------------------
1582 return DR_Pub details
1589 delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1596 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1597 :widths: 20, 15, 10, 10, 10, 20, 30
1599 pubId | path | Yes | string | | |
1612 successful operation
1615 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1619 .. code-block:: javascript
1622 "dcaeLocationName": "somestring",
1623 "feedId": "somestring",
1624 "lastMod": "2015-01-01T15:00:00.000Z",
1625 "pubId": "somestring",
1627 "username": "somestring",
1628 "userpwd": "somestring"
1637 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1641 .. code-block:: javascript
1644 "dcaeLocationName": "somestring",
1645 "feedId": "somestring",
1646 "lastMod": "2015-01-01T15:00:00.000Z",
1647 "pubId": "somestring",
1649 "username": "somestring",
1650 "userpwd": "somestring"
1659 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1663 .. code-block:: javascript
1667 "fields": "somestring",
1669 "message": "somestring"
1676 GET ``/dr_pubs/{pubId}``
1677 ------------------------
1683 return DR_Pub details
1690 returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1697 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1698 :widths: 20, 15, 10, 10, 10, 20, 30
1700 pubId | path | Yes | string | | |
1716 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1720 .. code-block:: javascript
1723 "dcaeLocationName": "somestring",
1724 "feedId": "somestring",
1725 "lastMod": "2015-01-01T15:00:00.000Z",
1726 "pubId": "somestring",
1728 "username": "somestring",
1729 "userpwd": "somestring"
1738 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1742 .. code-block:: javascript
1746 "fields": "somestring",
1748 "message": "somestring"
1762 return DR_Pub details
1769 Returns array of `DR_Pub` objects. Add filter for feedId.
1785 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1789 .. code-block:: javascript
1792 "dcaeLocationName": "somestring",
1793 "feedId": "somestring",
1794 "lastMod": "2015-01-01T15:00:00.000Z",
1795 "pubId": "somestring",
1797 "username": "somestring",
1798 "userpwd": "somestring"
1807 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1811 .. code-block:: javascript
1815 "fields": "somestring",
1817 "message": "somestring"
1824 PUT ``/dr_pubs/{pubId}``
1825 ------------------------
1831 return DR_Pub details
1838 update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
1845 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1846 :widths: 20, 15, 10, 10, 10, 20, 30
1848 pubId | path | Yes | string | | |
1864 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1868 .. code-block:: javascript
1871 "dcaeLocationName": "somestring",
1872 "feedId": "somestring",
1873 "lastMod": "2015-01-01T15:00:00.000Z",
1874 "pubId": "somestring",
1876 "username": "somestring",
1877 "userpwd": "somestring"
1886 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1890 .. code-block:: javascript
1894 "fields": "somestring",
1896 "message": "somestring"
1906 Endpoint for a Data Router client that implements a Subscriber
1919 return DR_Sub details
1926 Create a `DR_Sub` object.
1942 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
1946 .. code-block:: javascript
1953 "dcaeLocationName": "somestring",
1954 "deliveryURL": "somestring",
1955 "feedId": "somestring",
1956 "lastMod": "2015-01-01T15:00:00.000Z",
1957 "logURL": "somestring",
1958 "owner": "somestring",
1960 "subId": "somestring",
1963 "username": "somestring",
1964 "userpwd": "somestring"
1973 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1977 .. code-block:: javascript
1981 "fields": "somestring",
1983 "message": "somestring"
1990 DELETE ``/dr_subs/{subId}``
1991 ---------------------------
1997 return DR_Sub details
2004 Delete a `DR_Sub` object, selected by subId
2011 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2012 :widths: 20, 15, 10, 10, 10, 20, 30
2014 subId | path | Yes | string | | |
2030 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2034 .. code-block:: javascript
2041 "dcaeLocationName": "somestring",
2042 "deliveryURL": "somestring",
2043 "feedId": "somestring",
2044 "lastMod": "2015-01-01T15:00:00.000Z",
2045 "logURL": "somestring",
2046 "owner": "somestring",
2048 "subId": "somestring",
2051 "username": "somestring",
2052 "userpwd": "somestring"
2061 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2065 .. code-block:: javascript
2069 "fields": "somestring",
2071 "message": "somestring"
2078 GET ``/dr_subs/{subId}``
2079 ------------------------
2085 return DR_Sub details
2092 Retrieve a `DR_Sub` object, selected by subId
2099 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2100 :widths: 20, 15, 10, 10, 10, 20, 30
2102 subId | path | Yes | string | | |
2118 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2122 .. code-block:: javascript
2129 "dcaeLocationName": "somestring",
2130 "deliveryURL": "somestring",
2131 "feedId": "somestring",
2132 "lastMod": "2015-01-01T15:00:00.000Z",
2133 "logURL": "somestring",
2134 "owner": "somestring",
2136 "subId": "somestring",
2139 "username": "somestring",
2140 "userpwd": "somestring"
2149 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2153 .. code-block:: javascript
2157 "fields": "somestring",
2159 "message": "somestring"
2173 return DR_Sub details
2180 Returns array of `DR_Sub` objects. Add filter for feedId.
2196 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2200 .. code-block:: javascript
2207 "dcaeLocationName": "somestring",
2208 "deliveryURL": "somestring",
2209 "feedId": "somestring",
2210 "lastMod": "2015-01-01T15:00:00.000Z",
2211 "logURL": "somestring",
2212 "owner": "somestring",
2214 "subId": "somestring",
2217 "username": "somestring",
2218 "userpwd": "somestring"
2227 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2231 .. code-block:: javascript
2235 "fields": "somestring",
2237 "message": "somestring"
2244 PUT ``/dr_subs/{subId}``
2245 ------------------------
2251 return DR_Sub details
2258 Update a `DR_Sub` object, selected by subId
2265 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2266 :widths: 20, 15, 10, 10, 10, 20, 30
2268 subId | path | Yes | string | | |
2284 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2288 .. code-block:: javascript
2295 "dcaeLocationName": "somestring",
2296 "deliveryURL": "somestring",
2297 "feedId": "somestring",
2298 "lastMod": "2015-01-01T15:00:00.000Z",
2299 "logURL": "somestring",
2300 "owner": "somestring",
2302 "subId": "somestring",
2305 "username": "somestring",
2306 "userpwd": "somestring"
2315 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2319 .. code-block:: javascript
2323 "fields": "somestring",
2325 "message": "somestring"
2335 Endpoint for a Data Router Feed
2355 Create a of `Feed` object.
2362 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2363 :widths: 20, 15, 10, 10, 10, 20, 30
2365 useExisting | query | No | string | | |
2381 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2385 .. code-block:: javascript
2388 "asprClassification": "somestring",
2393 "feedDescription": "somestring",
2394 "feedId": "somestring",
2395 "feedName": "somestring",
2396 "feedVersion": "somestring",
2397 "formatUuid": "somestring",
2398 "lastMod": "2015-01-01T15:00:00.000Z",
2399 "logURL": "somestring",
2400 "owner": "somestring",
2401 "publishURL": "somestring",
2404 "dcaeLocationName": "somestring",
2405 "feedId": "somestring",
2406 "lastMod": "2015-01-01T15:00:00.000Z",
2407 "pubId": "somestring",
2409 "username": "somestring",
2410 "userpwd": "somestring"
2413 "dcaeLocationName": "somestring",
2414 "feedId": "somestring",
2415 "lastMod": "2015-01-01T15:00:00.000Z",
2416 "pubId": "somestring",
2418 "username": "somestring",
2419 "userpwd": "somestring"
2429 "dcaeLocationName": "somestring",
2430 "deliveryURL": "somestring",
2431 "feedId": "somestring",
2432 "lastMod": "2015-01-01T15:00:00.000Z",
2433 "logURL": "somestring",
2434 "owner": "somestring",
2436 "subId": "somestring",
2439 "username": "somestring",
2440 "userpwd": "somestring"
2447 "dcaeLocationName": "somestring",
2448 "deliveryURL": "somestring",
2449 "feedId": "somestring",
2450 "lastMod": "2015-01-01T15:00:00.000Z",
2451 "logURL": "somestring",
2452 "owner": "somestring",
2454 "subId": "somestring",
2457 "username": "somestring",
2458 "userpwd": "somestring"
2461 "subscribeURL": "somestring",
2471 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2475 .. code-block:: javascript
2479 "fields": "somestring",
2481 "message": "somestring"
2488 DELETE ``/feeds/{id}``
2489 ----------------------
2502 Delete a `Feed` object, specified by id.
2509 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2510 :widths: 20, 15, 10, 10, 10, 20, 30
2512 id | path | Yes | string | | |
2525 successful operation
2528 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2532 .. code-block:: javascript
2535 "asprClassification": "somestring",
2540 "feedDescription": "somestring",
2541 "feedId": "somestring",
2542 "feedName": "somestring",
2543 "feedVersion": "somestring",
2544 "formatUuid": "somestring",
2545 "lastMod": "2015-01-01T15:00:00.000Z",
2546 "logURL": "somestring",
2547 "owner": "somestring",
2548 "publishURL": "somestring",
2551 "dcaeLocationName": "somestring",
2552 "feedId": "somestring",
2553 "lastMod": "2015-01-01T15:00:00.000Z",
2554 "pubId": "somestring",
2556 "username": "somestring",
2557 "userpwd": "somestring"
2560 "dcaeLocationName": "somestring",
2561 "feedId": "somestring",
2562 "lastMod": "2015-01-01T15:00:00.000Z",
2563 "pubId": "somestring",
2565 "username": "somestring",
2566 "userpwd": "somestring"
2576 "dcaeLocationName": "somestring",
2577 "deliveryURL": "somestring",
2578 "feedId": "somestring",
2579 "lastMod": "2015-01-01T15:00:00.000Z",
2580 "logURL": "somestring",
2581 "owner": "somestring",
2583 "subId": "somestring",
2586 "username": "somestring",
2587 "userpwd": "somestring"
2594 "dcaeLocationName": "somestring",
2595 "deliveryURL": "somestring",
2596 "feedId": "somestring",
2597 "lastMod": "2015-01-01T15:00:00.000Z",
2598 "logURL": "somestring",
2599 "owner": "somestring",
2601 "subId": "somestring",
2604 "username": "somestring",
2605 "userpwd": "somestring"
2608 "subscribeURL": "somestring",
2618 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2622 .. code-block:: javascript
2625 "asprClassification": "somestring",
2630 "feedDescription": "somestring",
2631 "feedId": "somestring",
2632 "feedName": "somestring",
2633 "feedVersion": "somestring",
2634 "formatUuid": "somestring",
2635 "lastMod": "2015-01-01T15:00:00.000Z",
2636 "logURL": "somestring",
2637 "owner": "somestring",
2638 "publishURL": "somestring",
2641 "dcaeLocationName": "somestring",
2642 "feedId": "somestring",
2643 "lastMod": "2015-01-01T15:00:00.000Z",
2644 "pubId": "somestring",
2646 "username": "somestring",
2647 "userpwd": "somestring"
2650 "dcaeLocationName": "somestring",
2651 "feedId": "somestring",
2652 "lastMod": "2015-01-01T15:00:00.000Z",
2653 "pubId": "somestring",
2655 "username": "somestring",
2656 "userpwd": "somestring"
2666 "dcaeLocationName": "somestring",
2667 "deliveryURL": "somestring",
2668 "feedId": "somestring",
2669 "lastMod": "2015-01-01T15:00:00.000Z",
2670 "logURL": "somestring",
2671 "owner": "somestring",
2673 "subId": "somestring",
2676 "username": "somestring",
2677 "userpwd": "somestring"
2684 "dcaeLocationName": "somestring",
2685 "deliveryURL": "somestring",
2686 "feedId": "somestring",
2687 "lastMod": "2015-01-01T15:00:00.000Z",
2688 "logURL": "somestring",
2689 "owner": "somestring",
2691 "subId": "somestring",
2694 "username": "somestring",
2695 "userpwd": "somestring"
2698 "subscribeURL": "somestring",
2708 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2712 .. code-block:: javascript
2716 "fields": "somestring",
2718 "message": "somestring"
2739 Retrieve a `Feed` object, specified by id.
2746 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2747 :widths: 20, 15, 10, 10, 10, 20, 30
2749 id | path | Yes | string | | |
2765 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2769 .. code-block:: javascript
2772 "dcaeLocationName": "somestring",
2773 "feedId": "somestring",
2774 "lastMod": "2015-01-01T15:00:00.000Z",
2775 "pubId": "somestring",
2777 "username": "somestring",
2778 "userpwd": "somestring"
2787 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2791 .. code-block:: javascript
2795 "fields": "somestring",
2797 "message": "somestring"
2818 Returns array of `Feed` objects.
2825 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2826 :widths: 20, 15, 10, 10, 10, 20, 30
2828 feedName | query | No | string | | |
2829 version | query | No | string | | |
2830 match | query | No | string | | |
2846 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2850 .. code-block:: javascript
2853 "asprClassification": "somestring",
2858 "feedDescription": "somestring",
2859 "feedId": "somestring",
2860 "feedName": "somestring",
2861 "feedVersion": "somestring",
2862 "formatUuid": "somestring",
2863 "lastMod": "2015-01-01T15:00:00.000Z",
2864 "logURL": "somestring",
2865 "owner": "somestring",
2866 "publishURL": "somestring",
2869 "dcaeLocationName": "somestring",
2870 "feedId": "somestring",
2871 "lastMod": "2015-01-01T15:00:00.000Z",
2872 "pubId": "somestring",
2874 "username": "somestring",
2875 "userpwd": "somestring"
2878 "dcaeLocationName": "somestring",
2879 "feedId": "somestring",
2880 "lastMod": "2015-01-01T15:00:00.000Z",
2881 "pubId": "somestring",
2883 "username": "somestring",
2884 "userpwd": "somestring"
2894 "dcaeLocationName": "somestring",
2895 "deliveryURL": "somestring",
2896 "feedId": "somestring",
2897 "lastMod": "2015-01-01T15:00:00.000Z",
2898 "logURL": "somestring",
2899 "owner": "somestring",
2901 "subId": "somestring",
2904 "username": "somestring",
2905 "userpwd": "somestring"
2912 "dcaeLocationName": "somestring",
2913 "deliveryURL": "somestring",
2914 "feedId": "somestring",
2915 "lastMod": "2015-01-01T15:00:00.000Z",
2916 "logURL": "somestring",
2917 "owner": "somestring",
2919 "subId": "somestring",
2922 "username": "somestring",
2923 "userpwd": "somestring"
2926 "subscribeURL": "somestring",
2936 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2940 .. code-block:: javascript
2944 "fields": "somestring",
2946 "message": "somestring"
2967 Update a `Feed` object, specified by id.
2974 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2975 :widths: 20, 15, 10, 10, 10, 20, 30
2977 id | path | Yes | string | | |
2993 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2997 .. code-block:: javascript
3000 "asprClassification": "somestring",
3005 "feedDescription": "somestring",
3006 "feedId": "somestring",
3007 "feedName": "somestring",
3008 "feedVersion": "somestring",
3009 "formatUuid": "somestring",
3010 "lastMod": "2015-01-01T15:00:00.000Z",
3011 "logURL": "somestring",
3012 "owner": "somestring",
3013 "publishURL": "somestring",
3016 "dcaeLocationName": "somestring",
3017 "feedId": "somestring",
3018 "lastMod": "2015-01-01T15:00:00.000Z",
3019 "pubId": "somestring",
3021 "username": "somestring",
3022 "userpwd": "somestring"
3025 "dcaeLocationName": "somestring",
3026 "feedId": "somestring",
3027 "lastMod": "2015-01-01T15:00:00.000Z",
3028 "pubId": "somestring",
3030 "username": "somestring",
3031 "userpwd": "somestring"
3041 "dcaeLocationName": "somestring",
3042 "deliveryURL": "somestring",
3043 "feedId": "somestring",
3044 "lastMod": "2015-01-01T15:00:00.000Z",
3045 "logURL": "somestring",
3046 "owner": "somestring",
3048 "subId": "somestring",
3051 "username": "somestring",
3052 "userpwd": "somestring"
3059 "dcaeLocationName": "somestring",
3060 "deliveryURL": "somestring",
3061 "feedId": "somestring",
3062 "lastMod": "2015-01-01T15:00:00.000Z",
3063 "logURL": "somestring",
3064 "owner": "somestring",
3066 "subId": "somestring",
3069 "username": "somestring",
3070 "userpwd": "somestring"
3073 "subscribeURL": "somestring",
3083 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3087 .. code-block:: javascript
3091 "fields": "somestring",
3093 "message": "somestring"
3103 Endpoint for this instance of DBCL. Returns health info.
3123 returns the `info` object
3139 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
3143 .. code-block:: javascript
3146 "accessKeyOwner": "somestring",
3147 "bridgeAdminTopic": "somestring",
3148 "dmaapName": "somestring",
3149 "drProvUrl": "somestring",
3150 "lastMod": "2015-01-01T15:00:00.000Z",
3151 "loggingUrl": "somestring",
3152 "nodeKey": "somestring",
3154 "topicNsRoot": "somestring",
3155 "version": "somestring"
3164 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3168 .. code-block:: javascript
3172 "fields": "somestring",
3174 "message": "somestring"
3184 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
3190 POST ``/mr_clients``
3191 --------------------
3197 Associate an MR_Client object to a Topic
3204 Create a `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic. In legacy implementation, the `clientRole` is granted appropriate permission in AAF. Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.
3220 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3224 .. code-block:: javascript
3231 "clientIdentity": "somestring",
3232 "clientRole": "somestring",
3233 "dcaeLocationName": "somestring",
3234 "fqtn": "somestring",
3235 "lastMod": "2015-01-01T15:00:00.000Z",
3236 "mrClientId": "somestring",
3238 "topicURL": "somestring"
3247 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3251 .. code-block:: javascript
3255 "fields": "somestring",
3257 "message": "somestring"
3264 DELETE ``/mr_clients/{subId}``
3265 ------------------------------
3271 Delete an MR_Client object
3278 Delete a `MR_Client` object, specified by clientId
3285 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3286 :widths: 20, 15, 10, 10, 10, 20, 30
3288 subId | path | Yes | string | | |
3301 successful operation
3304 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3308 .. code-block:: javascript
3315 "clientIdentity": "somestring",
3316 "clientRole": "somestring",
3317 "dcaeLocationName": "somestring",
3318 "fqtn": "somestring",
3319 "lastMod": "2015-01-01T15:00:00.000Z",
3320 "mrClientId": "somestring",
3322 "topicURL": "somestring"
3331 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3335 .. code-block:: javascript
3342 "clientIdentity": "somestring",
3343 "clientRole": "somestring",
3344 "dcaeLocationName": "somestring",
3345 "fqtn": "somestring",
3346 "lastMod": "2015-01-01T15:00:00.000Z",
3347 "mrClientId": "somestring",
3349 "topicURL": "somestring"
3358 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3362 .. code-block:: javascript
3366 "fields": "somestring",
3368 "message": "somestring"
3382 return MR_Client details
3389 Returns array of `MR_Client` objects.
3405 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3409 .. code-block:: javascript
3416 "clientIdentity": "somestring",
3417 "clientRole": "somestring",
3418 "dcaeLocationName": "somestring",
3419 "fqtn": "somestring",
3420 "lastMod": "2015-01-01T15:00:00.000Z",
3421 "mrClientId": "somestring",
3423 "topicURL": "somestring"
3432 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3436 .. code-block:: javascript
3440 "fields": "somestring",
3442 "message": "somestring"
3449 GET ``/mr_clients/{subId}``
3450 ---------------------------
3456 return MR_Client details
3463 Retrieve a `MR_Client` object, specified by clientId
3470 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3471 :widths: 20, 15, 10, 10, 10, 20, 30
3473 subId | path | Yes | string | | |
3489 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3493 .. code-block:: javascript
3500 "clientIdentity": "somestring",
3501 "clientRole": "somestring",
3502 "dcaeLocationName": "somestring",
3503 "fqtn": "somestring",
3504 "lastMod": "2015-01-01T15:00:00.000Z",
3505 "mrClientId": "somestring",
3507 "topicURL": "somestring"
3516 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3520 .. code-block:: javascript
3524 "fields": "somestring",
3526 "message": "somestring"
3533 PUT ``/mr_clients/{clientId}``
3534 ------------------------------
3540 Update an MR_Client object
3547 Update a `MR_Client` object, specified by clientId
3554 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3555 :widths: 20, 15, 10, 10, 10, 20, 30
3557 clientId | path | Yes | string | | |
3573 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3577 .. code-block:: javascript
3584 "clientIdentity": "somestring",
3585 "clientRole": "somestring",
3586 "dcaeLocationName": "somestring",
3587 "fqtn": "somestring",
3588 "lastMod": "2015-01-01T15:00:00.000Z",
3589 "mrClientId": "somestring",
3591 "topicURL": "somestring"
3600 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3604 .. code-block:: javascript
3608 "fields": "somestring",
3610 "message": "somestring"
3620 Endpoint for a Message Router servers in a Cluster configuration
3626 POST ``/mr_clusters``
3627 ---------------------
3633 return MR_Cluster details
3640 Create an `MR_Cluster` object.
3656 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3660 .. code-block:: javascript
3663 "dcaeLocationName": "somestring",
3664 "fqdn": "somestring",
3665 "lastMod": "2015-01-01T15:00:00.000Z",
3666 "replicationGroup": "somestring",
3667 "sourceReplicationPort": "somestring",
3669 "targetReplicationPort": "somestring",
3670 "topicPort": "somestring",
3671 "topicProtocol": "somestring"
3680 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3684 .. code-block:: javascript
3688 "fields": "somestring",
3690 "message": "somestring"
3697 DELETE ``/mr_clusters/{clusterId}``
3698 -----------------------------------
3704 return MR_Cluster details
3711 Delete an `MR_Cluster` object, specified by clusterId.
3718 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3719 :widths: 20, 15, 10, 10, 10, 20, 30
3721 clusterId | path | Yes | string | | |
3734 successful operation
3737 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3741 .. code-block:: javascript
3744 "dcaeLocationName": "somestring",
3745 "fqdn": "somestring",
3746 "lastMod": "2015-01-01T15:00:00.000Z",
3747 "replicationGroup": "somestring",
3748 "sourceReplicationPort": "somestring",
3750 "targetReplicationPort": "somestring",
3751 "topicPort": "somestring",
3752 "topicProtocol": "somestring"
3761 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3765 .. code-block:: javascript
3768 "dcaeLocationName": "somestring",
3769 "fqdn": "somestring",
3770 "lastMod": "2015-01-01T15:00:00.000Z",
3771 "replicationGroup": "somestring",
3772 "sourceReplicationPort": "somestring",
3774 "targetReplicationPort": "somestring",
3775 "topicPort": "somestring",
3776 "topicProtocol": "somestring"
3785 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3789 .. code-block:: javascript
3793 "fields": "somestring",
3795 "message": "somestring"
3802 GET ``/mr_clusters/{clusterId}``
3803 --------------------------------
3809 return MR_Cluster details
3816 Retrieve an `MR_Cluster` object, specified by clusterId.
3823 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3824 :widths: 20, 15, 10, 10, 10, 20, 30
3826 clusterId | path | Yes | string | | |
3842 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3846 .. code-block:: javascript
3849 "dcaeLocationName": "somestring",
3850 "fqdn": "somestring",
3851 "lastMod": "2015-01-01T15:00:00.000Z",
3852 "replicationGroup": "somestring",
3853 "sourceReplicationPort": "somestring",
3855 "targetReplicationPort": "somestring",
3856 "topicPort": "somestring",
3857 "topicProtocol": "somestring"
3866 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3870 .. code-block:: javascript
3874 "fields": "somestring",
3876 "message": "somestring"
3883 GET ``/mr_clusters``
3884 --------------------
3890 return MR_Cluster details
3897 Returns array of `MR_Cluster` objects.
3913 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3917 .. code-block:: javascript
3920 "dcaeLocationName": "somestring",
3921 "fqdn": "somestring",
3922 "lastMod": "2015-01-01T15:00:00.000Z",
3923 "replicationGroup": "somestring",
3924 "sourceReplicationPort": "somestring",
3926 "targetReplicationPort": "somestring",
3927 "topicPort": "somestring",
3928 "topicProtocol": "somestring"
3937 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3941 .. code-block:: javascript
3945 "fields": "somestring",
3947 "message": "somestring"
3954 PUT ``/mr_clusters/{clusterId}``
3955 --------------------------------
3961 return MR_Cluster details
3968 Update an `MR_Cluster` object, specified by clusterId.
3975 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3976 :widths: 20, 15, 10, 10, 10, 20, 30
3978 clusterId | path | Yes | string | | |
3994 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3998 .. code-block:: javascript
4001 "dcaeLocationName": "somestring",
4002 "fqdn": "somestring",
4003 "lastMod": "2015-01-01T15:00:00.000Z",
4004 "replicationGroup": "somestring",
4005 "sourceReplicationPort": "somestring",
4007 "targetReplicationPort": "somestring",
4008 "topicPort": "somestring",
4009 "topicProtocol": "somestring"
4018 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4022 .. code-block:: javascript
4026 "fields": "somestring",
4028 "message": "somestring"
4038 Endpoint for retreiving MR Topics
4051 Create a Topic object
4058 Create `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`. Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic. MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.
4065 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4066 :widths: 20, 15, 10, 10, 10, 20, 30
4068 useExisting | query | No | string | | |
4084 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4088 .. code-block:: javascript
4097 "clientIdentity": "somestring",
4098 "clientRole": "somestring",
4099 "dcaeLocationName": "somestring",
4100 "fqtn": "somestring",
4101 "lastMod": "2015-01-01T15:00:00.000Z",
4102 "mrClientId": "somestring",
4104 "topicURL": "somestring"
4111 "clientIdentity": "somestring",
4112 "clientRole": "somestring",
4113 "dcaeLocationName": "somestring",
4114 "fqtn": "somestring",
4115 "lastMod": "2015-01-01T15:00:00.000Z",
4116 "mrClientId": "somestring",
4118 "topicURL": "somestring"
4121 "formatUuid": "somestring",
4122 "fqtn": "somestring",
4123 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4124 "globalMrURL": "somestring",
4125 "lastMod": "2015-01-01T15:00:00.000Z",
4126 "owner": "somestring",
4127 "partitionCount": "somestring",
4128 "publisherRole": "somestring",
4129 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4130 "replicationCount": "somestring",
4132 "subscriberRole": "somestring",
4133 "tnxEnabled": "somestring",
4134 "topicDescription": "somestring",
4135 "topicName": "somestring",
4136 "version": "somestring"
4145 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4149 .. code-block:: javascript
4153 "fields": "somestring",
4155 "message": "somestring"
4162 DELETE ``/topics/{topicId}``
4163 ----------------------------
4169 return Topic details
4176 Delete a `Topic` object, identified by topicId
4183 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4184 :widths: 20, 15, 10, 10, 10, 20, 30
4186 topicId | path | Yes | string | | |
4199 successful operation
4202 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4206 .. code-block:: javascript
4215 "clientIdentity": "somestring",
4216 "clientRole": "somestring",
4217 "dcaeLocationName": "somestring",
4218 "fqtn": "somestring",
4219 "lastMod": "2015-01-01T15:00:00.000Z",
4220 "mrClientId": "somestring",
4222 "topicURL": "somestring"
4229 "clientIdentity": "somestring",
4230 "clientRole": "somestring",
4231 "dcaeLocationName": "somestring",
4232 "fqtn": "somestring",
4233 "lastMod": "2015-01-01T15:00:00.000Z",
4234 "mrClientId": "somestring",
4236 "topicURL": "somestring"
4239 "formatUuid": "somestring",
4240 "fqtn": "somestring",
4241 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4242 "globalMrURL": "somestring",
4243 "lastMod": "2015-01-01T15:00:00.000Z",
4244 "owner": "somestring",
4245 "partitionCount": "somestring",
4246 "publisherRole": "somestring",
4247 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4248 "replicationCount": "somestring",
4250 "subscriberRole": "somestring",
4251 "tnxEnabled": "somestring",
4252 "topicDescription": "somestring",
4253 "topicName": "somestring",
4254 "version": "somestring"
4263 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4267 .. code-block:: javascript
4276 "clientIdentity": "somestring",
4277 "clientRole": "somestring",
4278 "dcaeLocationName": "somestring",
4279 "fqtn": "somestring",
4280 "lastMod": "2015-01-01T15:00:00.000Z",
4281 "mrClientId": "somestring",
4283 "topicURL": "somestring"
4290 "clientIdentity": "somestring",
4291 "clientRole": "somestring",
4292 "dcaeLocationName": "somestring",
4293 "fqtn": "somestring",
4294 "lastMod": "2015-01-01T15:00:00.000Z",
4295 "mrClientId": "somestring",
4297 "topicURL": "somestring"
4300 "formatUuid": "somestring",
4301 "fqtn": "somestring",
4302 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4303 "globalMrURL": "somestring",
4304 "lastMod": "2015-01-01T15:00:00.000Z",
4305 "owner": "somestring",
4306 "partitionCount": "somestring",
4307 "publisherRole": "somestring",
4308 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4309 "replicationCount": "somestring",
4311 "subscriberRole": "somestring",
4312 "tnxEnabled": "somestring",
4313 "topicDescription": "somestring",
4314 "topicName": "somestring",
4315 "version": "somestring"
4324 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4328 .. code-block:: javascript
4332 "fields": "somestring",
4334 "message": "somestring"
4341 GET ``/topics/{topicId}``
4342 -------------------------
4348 return Topic details
4355 Retrieve a `Topic` object, identified by topicId
4362 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4363 :widths: 20, 15, 10, 10, 10, 20, 30
4365 topicId | path | Yes | string | | |
4381 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4385 .. code-block:: javascript
4394 "clientIdentity": "somestring",
4395 "clientRole": "somestring",
4396 "dcaeLocationName": "somestring",
4397 "fqtn": "somestring",
4398 "lastMod": "2015-01-01T15:00:00.000Z",
4399 "mrClientId": "somestring",
4401 "topicURL": "somestring"
4408 "clientIdentity": "somestring",
4409 "clientRole": "somestring",
4410 "dcaeLocationName": "somestring",
4411 "fqtn": "somestring",
4412 "lastMod": "2015-01-01T15:00:00.000Z",
4413 "mrClientId": "somestring",
4415 "topicURL": "somestring"
4418 "formatUuid": "somestring",
4419 "fqtn": "somestring",
4420 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4421 "globalMrURL": "somestring",
4422 "lastMod": "2015-01-01T15:00:00.000Z",
4423 "owner": "somestring",
4424 "partitionCount": "somestring",
4425 "publisherRole": "somestring",
4426 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4427 "replicationCount": "somestring",
4429 "subscriberRole": "somestring",
4430 "tnxEnabled": "somestring",
4431 "topicDescription": "somestring",
4432 "topicName": "somestring",
4433 "version": "somestring"
4442 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4446 .. code-block:: javascript
4450 "fields": "somestring",
4452 "message": "somestring"
4466 return Topic details
4473 Returns array of `Topic` objects.
4489 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4493 .. code-block:: javascript
4502 "clientIdentity": "somestring",
4503 "clientRole": "somestring",
4504 "dcaeLocationName": "somestring",
4505 "fqtn": "somestring",
4506 "lastMod": "2015-01-01T15:00:00.000Z",
4507 "mrClientId": "somestring",
4509 "topicURL": "somestring"
4516 "clientIdentity": "somestring",
4517 "clientRole": "somestring",
4518 "dcaeLocationName": "somestring",
4519 "fqtn": "somestring",
4520 "lastMod": "2015-01-01T15:00:00.000Z",
4521 "mrClientId": "somestring",
4523 "topicURL": "somestring"
4526 "formatUuid": "somestring",
4527 "fqtn": "somestring",
4528 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4529 "globalMrURL": "somestring",
4530 "lastMod": "2015-01-01T15:00:00.000Z",
4531 "owner": "somestring",
4532 "partitionCount": "somestring",
4533 "publisherRole": "somestring",
4534 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4535 "replicationCount": "somestring",
4537 "subscriberRole": "somestring",
4538 "tnxEnabled": "somestring",
4539 "topicDescription": "somestring",
4540 "topicName": "somestring",
4541 "version": "somestring"
4550 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4554 .. code-block:: javascript
4558 "fields": "somestring",
4560 "message": "somestring"
4567 PUT ``/topics/{topicId}``
4568 -------------------------
4574 return Topic details
4581 Update a `Topic` object, identified by topicId
4588 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4589 :widths: 20, 15, 10, 10, 10, 20, 30
4591 topicId | path | Yes | string | | |
4607 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4611 .. code-block:: javascript
4620 "clientIdentity": "somestring",
4621 "clientRole": "somestring",
4622 "dcaeLocationName": "somestring",
4623 "fqtn": "somestring",
4624 "lastMod": "2015-01-01T15:00:00.000Z",
4625 "mrClientId": "somestring",
4627 "topicURL": "somestring"
4634 "clientIdentity": "somestring",
4635 "clientRole": "somestring",
4636 "dcaeLocationName": "somestring",
4637 "fqtn": "somestring",
4638 "lastMod": "2015-01-01T15:00:00.000Z",
4639 "mrClientId": "somestring",
4641 "topicURL": "somestring"
4644 "formatUuid": "somestring",
4645 "fqtn": "somestring",
4646 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4647 "globalMrURL": "somestring",
4648 "lastMod": "2015-01-01T15:00:00.000Z",
4649 "owner": "somestring",
4650 "partitionCount": "somestring",
4651 "publisherRole": "somestring",
4652 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4653 "replicationCount": "somestring",
4655 "subscriberRole": "somestring",
4656 "tnxEnabled": "somestring",
4657 "topicDescription": "somestring",
4658 "topicName": "somestring",
4659 "version": "somestring"
4668 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4672 .. code-block:: javascript
4676 "fields": "somestring",
4678 "message": "somestring"
4687 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
4689 ApiError Model Structure
4690 ------------------------
4694 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4695 :widths: 20, 10, 15, 15, 30, 25
4697 code | No | integer | int32 | |
4698 fields | No | string | | |
4699 is2xx | No | boolean | | |
4700 message | No | string | | |
4702 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
4704 BrTopic Model Structure
4705 -----------------------
4709 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4710 :widths: 20, 10, 15, 15, 30, 25
4712 brSource | No | string | | |
4713 brTarget | No | string | | |
4714 mmAgentName | No | string | | |
4715 topicCount | No | integer | int32 | |
4717 .. _d_d15e2cee407536866c875375e3f705e0:
4719 DR_Node Model Structure
4720 -----------------------
4724 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4725 :widths: 20, 10, 15, 15, 30, 25
4727 dcaeLocationName | No | string | | |
4728 fqdn | No | string | | |
4729 hostName | No | string | | |
4730 lastMod | No | string | date-time | | datestamp for last update to this object
4731 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4732 version | No | string | | |
4734 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4736 DR_Pub Model Structure
4737 ----------------------
4741 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4742 :widths: 20, 10, 15, 15, 30, 25
4744 dcaeLocationName | No | string | | |
4745 feedId | No | string | | |
4746 lastMod | No | string | date-time | | datestamp for last update to this object
4747 pubId | No | string | | |
4748 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4749 username | No | string | | |
4750 userpwd | No | string | | |
4752 .. _d_48cf328d246f41e1d11a09251b042f02:
4754 DR_Sub Model Structure
4755 ----------------------
4759 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4760 :widths: 20, 10, 15, 15, 30, 25
4762 bytes | No | array of string | | |
4763 dcaeLocationName | No | string | | |
4764 deliveryURL | No | string | | |
4765 feedId | No | string | | |
4766 lastMod | No | string | date-time | | datestamp for last update to this object
4767 logURL | No | string | | |
4768 owner | No | string | | |
4769 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4770 subId | No | string | | |
4771 suspended | No | boolean | | |
4772 use100 | No | boolean | | |
4773 username | No | string | | |
4774 userpwd | No | string | | |
4776 .. _d_47d80e451933beb623fcf5257867cbcb:
4778 DcaeLocation Model Structure
4779 ----------------------------
4783 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4784 :widths: 20, 10, 15, 15, 30, 25
4786 central | No | boolean | | |
4787 clli | No | string | | |
4788 dcaeLayer | No | string | | |
4789 dcaeLocationName | No | string | | |
4790 lastMod | No | string | date-time | | datestamp for last update to this object
4791 local | No | boolean | | |
4792 openStackAvailabilityZone | No | string | | |
4793 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4794 subnet | No | string | | |
4796 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4798 Dmaap Model Structure
4799 ---------------------
4803 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4804 :widths: 20, 10, 15, 15, 30, 25
4806 accessKeyOwner | No | string | | |
4807 bridgeAdminTopic | No | string | | |
4808 dmaapName | No | string | | |
4809 drProvUrl | No | string | | |
4810 lastMod | No | string | date-time | | datestamp for last update to this object
4811 loggingUrl | No | string | | |
4812 nodeKey | No | string | | |
4813 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4814 topicNsRoot | No | string | | |
4815 version | No | string | | |
4817 .. _d_289ad39619725df26c9ff382d4c97c75:
4819 Feed Model Structure
4820 --------------------
4824 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4825 :widths: 20, 10, 15, 15, 30, 25
4827 asprClassification | No | string | | |
4828 bytes | No | array of string | | |
4829 feedDescription | No | string | | |
4830 feedId | No | string | | |
4831 feedName | No | string | | |
4832 feedVersion | No | string | | |
4833 formatUuid | No | string | | |
4834 lastMod | No | string | date-time | | datestamp for last update to this object
4835 logURL | No | string | | |
4836 owner | No | string | | |
4837 publishURL | No | string | | |
4838 pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
4839 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4840 subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
4841 subscribeURL | No | string | | |
4842 suspended | No | boolean | | |
4844 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4846 MR_Client Model Structure
4847 -------------------------
4851 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4852 :widths: 20, 10, 15, 15, 30, 25
4854 action | No | array of string | | | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
4855 clientIdentity | No | string | | | an AAF identity to be associated to an appropriate topic Role
4856 clientRole | No | string | | | an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility.
4857 dcaeLocationName | No | string | | | a tag indicating a logical deployment site
4858 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi
4859 lastMod | No | string | date-time | | datestamp for last update to this object
4860 mrClientId | No | string | | | a unique identifier generated by dbcapi for this client
4861 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4862 topicURL | No | string | | | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
4864 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4866 MR_Cluster Model Structure
4867 --------------------------
4871 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4872 :widths: 20, 10, 15, 15, 30, 25
4874 dcaeLocationName | No | string | | |
4875 fqdn | No | string | | |
4876 lastMod | No | string | date-time | |
4877 replicationGroup | No | string | | |
4878 sourceReplicationPort | No | string | | |
4879 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4880 targetReplicationPort | No | string | | |
4881 topicPort | No | string | | |
4882 topicProtocol | No | string | | |
4884 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4886 MirrorMaker Model Structure
4887 ---------------------------
4891 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4892 :widths: 20, 10, 15, 15, 30, 25
4894 lastMod | No | string | date-time | | datestamp for last update to this object
4895 mmName | No | string | | |
4896 sourceCluster | No | string | | |
4897 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4898 targetCluster | No | string | | |
4899 topicCount | No | integer | int32 | |
4900 topics | No | array of string | | |
4901 whitelistUpdateJSON | No | string | | |
4903 .. _d_2e99841971da81b9d240071b86bf168d:
4905 Topic Model Structure
4906 ---------------------
4910 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4911 :widths: 20, 10, 15, 15, 30, 25
4913 clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | | an array of `MR_Client` objects associated to this `Topic`
4914 formatUuid | No | string | | | a reference to an identifier that describes a data format used for this `Topic`
4915 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
4916 fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
4917 globalMrURL | No | string | | | the URL of an outside MR instance
4918 lastMod | No | string | date-time | | datestamp for last update to this object
4919 owner | No | string | | | a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity.
4920 partitionCount | No | string | | | the kafka attribute for specifying the number of partitions
4921 publisherRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
4922 replicationCase | No | string | | {'enum': ['REPLICATION_NOT_SPECIFIED', 'REPLICATION_NONE', 'REPLICATION_EDGE_TO_CENTRAL', 'REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL', 'REPLICATION_CENTRAL_TO_EDGE', 'REPLICATION_CENTRAL_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_CENTRAL', 'REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE', 'REPLICATION_EDGE_TO_FQDN', 'REPLICATION_FQDN_TO_EDGE', 'REPLICATION_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN', 'REPLICATION_EDGE_TO_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN_TO_EDGE']} | An indicator for how this `Topic` should be replicated when there are more than one `MR_Cluster` instances
4923 replicationCount | No | string | | | the kafka attribute for specifying replication within an `MR_Cluster` instance
4924 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4925 subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
4926 tnxEnabled | No | string | | |
4927 topicDescription | No | string | | | a description of what this Topic is used for
4928 topicName | No | string | | | the short name used by humans, and utilized to construct the `FQTN`
4929 version | No | string | | | a hook for any versioning needed for managing a `Topic` over time