1 DMaaP Bus Controller REST API 1.1.0
2 ===================================
12 provides an API for OpenDCAE components which need to provision
13 underlying DMaaP technologies (Data Router and Message Router).
14 Primary clients for this API are anticipated to be the OpenDCAE
15 Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
18 Objects managed by DMaaP are deployed in a dcaeLocation which is a
19 unique identifier for an OpenStack tenant for a dcaeLayer,
20 opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
22 A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
23 DMaaP is managed by a one or more stateless DMaaP Bus
24 Controller(s), though Bus Controller relies on PGaaS for
25 persistence. Each DMaaP has a single instance of Data Router,
26 which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
27 Clients of type DR_Pub generally publish to a DR_Node that is
28 local to its dcaeLocation. Routing for a Feed is determined by
29 the dcaelocation of its DR_Sub clients.
31 A DMaaP may have many Message Router instances. Each instance is
32 deployed as an MR_Cluster. One MR_Cluster is deployed at each
33 dcaeLocation. MR_Clients generally communicate to the
34 MR_Cluster at the same dcaeLocation. Replication of messages
35 between MR_Clusters is accomplished by MR Bridge, which is
36 provioned by DMaaP Bus Controller based on Topic attributes.
38 Therefore, the role of DMaaP Bus Controller is to support other
39 DCAE infrastructure components to dynamically provision DMaaP
40 services on behalf of DMaaP clients, and to assist in any
41 management or discovery activity of its clients.
43 A convention of this API is to return JSON responses per
63 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
71 http://www.[host]:[port]/webapi
72 https://www.[host]:[port]/webapi
78 Endpoint for retreiving MR Bridge metrics
91 return BrTopic details
98 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.
105 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
106 :widths: 20, 15, 10, 10, 10, 20, 30
108 mmagent | query | No | string | | |
109 detail | query | No | boolean | | |
125 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
129 .. code-block:: javascript
132 "brSource": "somestring",
133 "brTarget": "somestring",
134 "mmAgentName": "somestring",
144 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
148 .. code-block:: javascript
152 "fields": "somestring",
154 "message": "somestring"
168 update MirrorMaker details
175 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.
182 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
183 :widths: 20, 15, 10, 10, 10, 20, 30
185 mmagent | query | No | string | | |
186 refresh | query | No | boolean | | |
187 split | query | No | boolean | | |
203 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
207 .. code-block:: javascript
210 "brSource": "somestring",
211 "brTarget": "somestring",
212 "mmAgentName": "somestring",
222 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
226 .. code-block:: javascript
230 "fields": "somestring",
232 "message": "somestring"
242 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
248 POST ``/dcaeLocations``
249 -----------------------
255 return dcaeLocation details
262 Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
278 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
282 .. code-block:: javascript
286 "clli": "somestring",
287 "dcaeLayer": "somestring",
288 "dcaeLocationName": "somestring",
289 "lastMod": "2015-01-01T15:00:00.000Z",
291 "openStackAvailabilityZone": "somestring",
293 "subnet": "somestring"
302 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
306 .. code-block:: javascript
310 "fields": "somestring",
312 "message": "somestring"
319 DELETE ``/dcaeLocations/{locationName}``
320 ----------------------------------------
326 return dcaeLocation details
333 delete a dcaeLocation
340 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
341 :widths: 20, 15, 10, 10, 10, 20, 30
343 locationName | path | Yes | string | | |
359 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
363 .. code-block:: javascript
367 "clli": "somestring",
368 "dcaeLayer": "somestring",
369 "dcaeLocationName": "somestring",
370 "lastMod": "2015-01-01T15:00:00.000Z",
372 "openStackAvailabilityZone": "somestring",
374 "subnet": "somestring"
383 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
387 .. code-block:: javascript
391 "clli": "somestring",
392 "dcaeLayer": "somestring",
393 "dcaeLocationName": "somestring",
394 "lastMod": "2015-01-01T15:00:00.000Z",
396 "openStackAvailabilityZone": "somestring",
398 "subnet": "somestring"
407 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
411 .. code-block:: javascript
415 "fields": "somestring",
417 "message": "somestring"
424 GET ``/dcaeLocations/{locationName}``
425 -------------------------------------
431 return dcaeLocation details
438 Returns a specific `dcaeLocation` object with specified tag
445 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
446 :widths: 20, 15, 10, 10, 10, 20, 30
448 locationName | path | Yes | string | | |
464 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
468 .. code-block:: javascript
472 "clli": "somestring",
473 "dcaeLayer": "somestring",
474 "dcaeLocationName": "somestring",
475 "lastMod": "2015-01-01T15:00:00.000Z",
477 "openStackAvailabilityZone": "somestring",
479 "subnet": "somestring"
488 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
492 .. code-block:: javascript
496 "fields": "somestring",
498 "message": "somestring"
505 GET ``/dcaeLocations``
506 ----------------------
512 return dcaeLocation details
519 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).
535 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
539 .. code-block:: javascript
543 "clli": "somestring",
544 "dcaeLayer": "somestring",
545 "dcaeLocationName": "somestring",
546 "lastMod": "2015-01-01T15:00:00.000Z",
548 "openStackAvailabilityZone": "somestring",
550 "subnet": "somestring"
559 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
563 .. code-block:: javascript
567 "fields": "somestring",
569 "message": "somestring"
576 PUT ``/dcaeLocations/{locationName}``
577 -------------------------------------
583 return dcaeLocation details
590 update the openStackAvailabilityZone of a dcaeLocation
597 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
598 :widths: 20, 15, 10, 10, 10, 20, 30
600 locationName | path | Yes | string | | |
616 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
620 .. code-block:: javascript
624 "clli": "somestring",
625 "dcaeLayer": "somestring",
626 "dcaeLocationName": "somestring",
627 "lastMod": "2015-01-01T15:00:00.000Z",
629 "openStackAvailabilityZone": "somestring",
631 "subnet": "somestring"
640 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
644 .. code-block:: javascript
648 "fields": "somestring",
650 "message": "somestring"
660 V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
680 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
696 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
700 .. code-block:: javascript
703 "accessKeyOwner": "somestring",
704 "bridgeAdminTopic": "somestring",
705 "dmaapName": "somestring",
706 "drProvUrl": "somestring",
707 "lastMod": "2015-01-01T15:00:00.000Z",
708 "loggingUrl": "somestring",
709 "nodeKey": "somestring",
711 "topicNsRoot": "somestring",
712 "version": "somestring"
721 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
725 .. code-block:: javascript
729 "fields": "somestring",
731 "message": "somestring"
752 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
768 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
772 .. code-block:: javascript
775 "accessKeyOwner": "somestring",
776 "bridgeAdminTopic": "somestring",
777 "dmaapName": "somestring",
778 "drProvUrl": "somestring",
779 "lastMod": "2015-01-01T15:00:00.000Z",
780 "loggingUrl": "somestring",
781 "nodeKey": "somestring",
783 "topicNsRoot": "somestring",
784 "version": "somestring"
793 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
797 .. code-block:: javascript
801 "fields": "somestring",
803 "message": "somestring"
824 returns the `dmaap` object, which contains system wide configuration settings
840 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
844 .. code-block:: javascript
847 "accessKeyOwner": "somestring",
848 "bridgeAdminTopic": "somestring",
849 "dmaapName": "somestring",
850 "drProvUrl": "somestring",
851 "lastMod": "2015-01-01T15:00:00.000Z",
852 "loggingUrl": "somestring",
853 "nodeKey": "somestring",
855 "topicNsRoot": "somestring",
856 "version": "somestring"
865 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
869 .. code-block:: javascript
873 "fields": "somestring",
875 "message": "somestring"
896 returns the `dmaap` object, which contains system wide configuration settings
912 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
916 .. code-block:: javascript
919 "accessKeyOwner": "somestring",
920 "bridgeAdminTopic": "somestring",
921 "dmaapName": "somestring",
922 "drProvUrl": "somestring",
923 "lastMod": "2015-01-01T15:00:00.000Z",
924 "loggingUrl": "somestring",
925 "nodeKey": "somestring",
927 "topicNsRoot": "somestring",
928 "version": "somestring"
937 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
941 .. code-block:: javascript
945 "fields": "somestring",
947 "message": "somestring"
968 Update system settings for *dcaeEnvironment*.
984 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
988 .. code-block:: javascript
991 "accessKeyOwner": "somestring",
992 "bridgeAdminTopic": "somestring",
993 "dmaapName": "somestring",
994 "drProvUrl": "somestring",
995 "lastMod": "2015-01-01T15:00:00.000Z",
996 "loggingUrl": "somestring",
997 "nodeKey": "somestring",
999 "topicNsRoot": "somestring",
1000 "version": "somestring"
1009 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1013 .. code-block:: javascript
1017 "fields": "somestring",
1019 "message": "somestring"
1033 return dmaap details
1040 Update system settings for *dcaeEnvironment*.
1056 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1060 .. code-block:: javascript
1063 "accessKeyOwner": "somestring",
1064 "bridgeAdminTopic": "somestring",
1065 "dmaapName": "somestring",
1066 "drProvUrl": "somestring",
1067 "lastMod": "2015-01-01T15:00:00.000Z",
1068 "loggingUrl": "somestring",
1069 "nodeKey": "somestring",
1071 "topicNsRoot": "somestring",
1072 "version": "somestring"
1081 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1085 .. code-block:: javascript
1089 "fields": "somestring",
1091 "message": "somestring"
1101 Endpoint for a Data Router Node server
1114 return DR_Node details
1121 create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
1137 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1141 .. code-block:: javascript
1144 "dcaeLocationName": "somestring",
1145 "fqdn": "somestring",
1146 "hostName": "somestring",
1147 "lastMod": "2015-01-01T15:00:00.000Z",
1149 "version": "somestring"
1158 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1162 .. code-block:: javascript
1166 "fields": "somestring",
1168 "message": "somestring"
1175 DELETE ``/dr_nodes/{fqdn}``
1176 ---------------------------
1189 Delete a single `DR_Node` object.
1196 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1197 :widths: 20, 15, 10, 10, 10, 20, 30
1199 fqdn | path | Yes | string | | |
1212 successful operation
1215 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1219 .. code-block:: javascript
1222 "dcaeLocationName": "somestring",
1223 "fqdn": "somestring",
1224 "hostName": "somestring",
1225 "lastMod": "2015-01-01T15:00:00.000Z",
1227 "version": "somestring"
1236 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1240 .. code-block:: javascript
1243 "dcaeLocationName": "somestring",
1244 "fqdn": "somestring",
1245 "hostName": "somestring",
1246 "lastMod": "2015-01-01T15:00:00.000Z",
1248 "version": "somestring"
1257 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1261 .. code-block:: javascript
1265 "fields": "somestring",
1267 "message": "somestring"
1274 GET ``/dr_nodes/{fqdn}``
1275 ------------------------
1281 return DR_Node details
1288 Retrieve a single `DR_Node` object.
1295 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1296 :widths: 20, 15, 10, 10, 10, 20, 30
1298 fqdn | path | Yes | string | | |
1314 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1318 .. code-block:: javascript
1321 "dcaeLocationName": "somestring",
1322 "fqdn": "somestring",
1323 "hostName": "somestring",
1324 "lastMod": "2015-01-01T15:00:00.000Z",
1326 "version": "somestring"
1335 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1339 .. code-block:: javascript
1343 "fields": "somestring",
1345 "message": "somestring"
1359 return DR_Node details
1366 Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
1382 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1386 .. code-block:: javascript
1389 "dcaeLocationName": "somestring",
1390 "fqdn": "somestring",
1391 "hostName": "somestring",
1392 "lastMod": "2015-01-01T15:00:00.000Z",
1394 "version": "somestring"
1403 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1407 .. code-block:: javascript
1411 "fields": "somestring",
1413 "message": "somestring"
1420 PUT ``/dr_nodes/{fqdn}``
1421 ------------------------
1427 return DR_Node details
1434 Update a single `DR_Node` object.
1441 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1442 :widths: 20, 15, 10, 10, 10, 20, 30
1444 fqdn | path | Yes | string | | |
1460 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1464 .. code-block:: javascript
1467 "dcaeLocationName": "somestring",
1468 "fqdn": "somestring",
1469 "hostName": "somestring",
1470 "lastMod": "2015-01-01T15:00:00.000Z",
1472 "version": "somestring"
1481 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1485 .. code-block:: javascript
1489 "fields": "somestring",
1491 "message": "somestring"
1501 Endpoint for a Data Router client that implements a Publisher
1514 return DR_Pub details
1521 create a DR Publisher in the specified environment.
1537 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1541 .. code-block:: javascript
1544 "dcaeLocationName": "somestring",
1545 "feedId": "somestring",
1546 "lastMod": "2015-01-01T15:00:00.000Z",
1547 "pubId": "somestring",
1549 "username": "somestring",
1550 "userpwd": "somestring"
1559 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1563 .. code-block:: javascript
1567 "fields": "somestring",
1569 "message": "somestring"
1576 DELETE ``/dr_pubs/{pubId}``
1577 ---------------------------
1583 return DR_Pub details
1590 delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1597 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1598 :widths: 20, 15, 10, 10, 10, 20, 30
1600 pubId | path | Yes | string | | |
1613 successful operation
1616 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1620 .. code-block:: javascript
1623 "dcaeLocationName": "somestring",
1624 "feedId": "somestring",
1625 "lastMod": "2015-01-01T15:00:00.000Z",
1626 "pubId": "somestring",
1628 "username": "somestring",
1629 "userpwd": "somestring"
1638 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1642 .. code-block:: javascript
1645 "dcaeLocationName": "somestring",
1646 "feedId": "somestring",
1647 "lastMod": "2015-01-01T15:00:00.000Z",
1648 "pubId": "somestring",
1650 "username": "somestring",
1651 "userpwd": "somestring"
1660 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1664 .. code-block:: javascript
1668 "fields": "somestring",
1670 "message": "somestring"
1677 GET ``/dr_pubs/{pubId}``
1678 ------------------------
1684 return DR_Pub details
1691 returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1698 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1699 :widths: 20, 15, 10, 10, 10, 20, 30
1701 pubId | path | Yes | string | | |
1717 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1721 .. code-block:: javascript
1724 "dcaeLocationName": "somestring",
1725 "feedId": "somestring",
1726 "lastMod": "2015-01-01T15:00:00.000Z",
1727 "pubId": "somestring",
1729 "username": "somestring",
1730 "userpwd": "somestring"
1739 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1743 .. code-block:: javascript
1747 "fields": "somestring",
1749 "message": "somestring"
1763 return DR_Pub details
1770 Returns array of `DR_Pub` objects. Add filter for feedId.
1786 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1790 .. code-block:: javascript
1793 "dcaeLocationName": "somestring",
1794 "feedId": "somestring",
1795 "lastMod": "2015-01-01T15:00:00.000Z",
1796 "pubId": "somestring",
1798 "username": "somestring",
1799 "userpwd": "somestring"
1808 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1812 .. code-block:: javascript
1816 "fields": "somestring",
1818 "message": "somestring"
1825 PUT ``/dr_pubs/{pubId}``
1826 ------------------------
1832 return DR_Pub details
1839 update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
1846 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1847 :widths: 20, 15, 10, 10, 10, 20, 30
1849 pubId | path | Yes | string | | |
1865 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1869 .. code-block:: javascript
1872 "dcaeLocationName": "somestring",
1873 "feedId": "somestring",
1874 "lastMod": "2015-01-01T15:00:00.000Z",
1875 "pubId": "somestring",
1877 "username": "somestring",
1878 "userpwd": "somestring"
1887 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1891 .. code-block:: javascript
1895 "fields": "somestring",
1897 "message": "somestring"
1907 Endpoint for a Data Router client that implements a Subscriber
1920 return DR_Sub details
1927 Create a `DR_Sub` object.
1943 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
1947 .. code-block:: javascript
1954 "dcaeLocationName": "somestring",
1955 "deliveryURL": "somestring",
1956 "feedId": "somestring",
1957 "lastMod": "2015-01-01T15:00:00.000Z",
1958 "logURL": "somestring",
1959 "owner": "somestring",
1961 "subId": "somestring",
1964 "username": "somestring",
1965 "userpwd": "somestring"
1974 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1978 .. code-block:: javascript
1982 "fields": "somestring",
1984 "message": "somestring"
1991 DELETE ``/dr_subs/{subId}``
1992 ---------------------------
1998 return DR_Sub details
2005 Delete a `DR_Sub` object, selected by subId
2012 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2013 :widths: 20, 15, 10, 10, 10, 20, 30
2015 subId | path | Yes | string | | |
2031 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2035 .. code-block:: javascript
2042 "dcaeLocationName": "somestring",
2043 "deliveryURL": "somestring",
2044 "feedId": "somestring",
2045 "lastMod": "2015-01-01T15:00:00.000Z",
2046 "logURL": "somestring",
2047 "owner": "somestring",
2049 "subId": "somestring",
2052 "username": "somestring",
2053 "userpwd": "somestring"
2062 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2066 .. code-block:: javascript
2070 "fields": "somestring",
2072 "message": "somestring"
2079 GET ``/dr_subs/{subId}``
2080 ------------------------
2086 return DR_Sub details
2093 Retrieve a `DR_Sub` object, selected by subId
2100 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2101 :widths: 20, 15, 10, 10, 10, 20, 30
2103 subId | path | Yes | string | | |
2119 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2123 .. code-block:: javascript
2130 "dcaeLocationName": "somestring",
2131 "deliveryURL": "somestring",
2132 "feedId": "somestring",
2133 "lastMod": "2015-01-01T15:00:00.000Z",
2134 "logURL": "somestring",
2135 "owner": "somestring",
2137 "subId": "somestring",
2140 "username": "somestring",
2141 "userpwd": "somestring"
2150 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2154 .. code-block:: javascript
2158 "fields": "somestring",
2160 "message": "somestring"
2174 return DR_Sub details
2181 Returns array of `DR_Sub` objects. Add filter for feedId.
2197 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2201 .. code-block:: javascript
2208 "dcaeLocationName": "somestring",
2209 "deliveryURL": "somestring",
2210 "feedId": "somestring",
2211 "lastMod": "2015-01-01T15:00:00.000Z",
2212 "logURL": "somestring",
2213 "owner": "somestring",
2215 "subId": "somestring",
2218 "username": "somestring",
2219 "userpwd": "somestring"
2228 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2232 .. code-block:: javascript
2236 "fields": "somestring",
2238 "message": "somestring"
2245 PUT ``/dr_subs/{subId}``
2246 ------------------------
2252 return DR_Sub details
2259 Update a `DR_Sub` object, selected by subId
2266 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2267 :widths: 20, 15, 10, 10, 10, 20, 30
2269 subId | path | Yes | string | | |
2285 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2289 .. code-block:: javascript
2296 "dcaeLocationName": "somestring",
2297 "deliveryURL": "somestring",
2298 "feedId": "somestring",
2299 "lastMod": "2015-01-01T15:00:00.000Z",
2300 "logURL": "somestring",
2301 "owner": "somestring",
2303 "subId": "somestring",
2306 "username": "somestring",
2307 "userpwd": "somestring"
2316 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2320 .. code-block:: javascript
2324 "fields": "somestring",
2326 "message": "somestring"
2336 Endpoint for a Data Router Feed
2356 Create a of `Feed` object.
2363 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2364 :widths: 20, 15, 10, 10, 10, 20, 30
2366 useExisting | query | No | string | | |
2382 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2386 .. code-block:: javascript
2389 "asprClassification": "somestring",
2394 "feedDescription": "somestring",
2395 "feedId": "somestring",
2396 "feedName": "somestring",
2397 "feedVersion": "somestring",
2398 "formatUuid": "somestring",
2399 "lastMod": "2015-01-01T15:00:00.000Z",
2400 "logURL": "somestring",
2401 "owner": "somestring",
2402 "publishURL": "somestring",
2405 "dcaeLocationName": "somestring",
2406 "feedId": "somestring",
2407 "lastMod": "2015-01-01T15:00:00.000Z",
2408 "pubId": "somestring",
2410 "username": "somestring",
2411 "userpwd": "somestring"
2414 "dcaeLocationName": "somestring",
2415 "feedId": "somestring",
2416 "lastMod": "2015-01-01T15:00:00.000Z",
2417 "pubId": "somestring",
2419 "username": "somestring",
2420 "userpwd": "somestring"
2430 "dcaeLocationName": "somestring",
2431 "deliveryURL": "somestring",
2432 "feedId": "somestring",
2433 "lastMod": "2015-01-01T15:00:00.000Z",
2434 "logURL": "somestring",
2435 "owner": "somestring",
2437 "subId": "somestring",
2440 "username": "somestring",
2441 "userpwd": "somestring"
2448 "dcaeLocationName": "somestring",
2449 "deliveryURL": "somestring",
2450 "feedId": "somestring",
2451 "lastMod": "2015-01-01T15:00:00.000Z",
2452 "logURL": "somestring",
2453 "owner": "somestring",
2455 "subId": "somestring",
2458 "username": "somestring",
2459 "userpwd": "somestring"
2462 "subscribeURL": "somestring",
2472 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2476 .. code-block:: javascript
2480 "fields": "somestring",
2482 "message": "somestring"
2489 DELETE ``/feeds/{id}``
2490 ----------------------
2503 Delete a `Feed` object, specified by id.
2510 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2511 :widths: 20, 15, 10, 10, 10, 20, 30
2513 id | path | Yes | string | | |
2526 successful operation
2529 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2533 .. code-block:: javascript
2536 "asprClassification": "somestring",
2541 "feedDescription": "somestring",
2542 "feedId": "somestring",
2543 "feedName": "somestring",
2544 "feedVersion": "somestring",
2545 "formatUuid": "somestring",
2546 "lastMod": "2015-01-01T15:00:00.000Z",
2547 "logURL": "somestring",
2548 "owner": "somestring",
2549 "publishURL": "somestring",
2552 "dcaeLocationName": "somestring",
2553 "feedId": "somestring",
2554 "lastMod": "2015-01-01T15:00:00.000Z",
2555 "pubId": "somestring",
2557 "username": "somestring",
2558 "userpwd": "somestring"
2561 "dcaeLocationName": "somestring",
2562 "feedId": "somestring",
2563 "lastMod": "2015-01-01T15:00:00.000Z",
2564 "pubId": "somestring",
2566 "username": "somestring",
2567 "userpwd": "somestring"
2577 "dcaeLocationName": "somestring",
2578 "deliveryURL": "somestring",
2579 "feedId": "somestring",
2580 "lastMod": "2015-01-01T15:00:00.000Z",
2581 "logURL": "somestring",
2582 "owner": "somestring",
2584 "subId": "somestring",
2587 "username": "somestring",
2588 "userpwd": "somestring"
2595 "dcaeLocationName": "somestring",
2596 "deliveryURL": "somestring",
2597 "feedId": "somestring",
2598 "lastMod": "2015-01-01T15:00:00.000Z",
2599 "logURL": "somestring",
2600 "owner": "somestring",
2602 "subId": "somestring",
2605 "username": "somestring",
2606 "userpwd": "somestring"
2609 "subscribeURL": "somestring",
2619 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2623 .. code-block:: javascript
2626 "asprClassification": "somestring",
2631 "feedDescription": "somestring",
2632 "feedId": "somestring",
2633 "feedName": "somestring",
2634 "feedVersion": "somestring",
2635 "formatUuid": "somestring",
2636 "lastMod": "2015-01-01T15:00:00.000Z",
2637 "logURL": "somestring",
2638 "owner": "somestring",
2639 "publishURL": "somestring",
2642 "dcaeLocationName": "somestring",
2643 "feedId": "somestring",
2644 "lastMod": "2015-01-01T15:00:00.000Z",
2645 "pubId": "somestring",
2647 "username": "somestring",
2648 "userpwd": "somestring"
2651 "dcaeLocationName": "somestring",
2652 "feedId": "somestring",
2653 "lastMod": "2015-01-01T15:00:00.000Z",
2654 "pubId": "somestring",
2656 "username": "somestring",
2657 "userpwd": "somestring"
2667 "dcaeLocationName": "somestring",
2668 "deliveryURL": "somestring",
2669 "feedId": "somestring",
2670 "lastMod": "2015-01-01T15:00:00.000Z",
2671 "logURL": "somestring",
2672 "owner": "somestring",
2674 "subId": "somestring",
2677 "username": "somestring",
2678 "userpwd": "somestring"
2685 "dcaeLocationName": "somestring",
2686 "deliveryURL": "somestring",
2687 "feedId": "somestring",
2688 "lastMod": "2015-01-01T15:00:00.000Z",
2689 "logURL": "somestring",
2690 "owner": "somestring",
2692 "subId": "somestring",
2695 "username": "somestring",
2696 "userpwd": "somestring"
2699 "subscribeURL": "somestring",
2709 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2713 .. code-block:: javascript
2717 "fields": "somestring",
2719 "message": "somestring"
2740 Retrieve a `Feed` object, specified by id.
2747 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2748 :widths: 20, 15, 10, 10, 10, 20, 30
2750 id | path | Yes | string | | |
2766 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2770 .. code-block:: javascript
2773 "dcaeLocationName": "somestring",
2774 "feedId": "somestring",
2775 "lastMod": "2015-01-01T15:00:00.000Z",
2776 "pubId": "somestring",
2778 "username": "somestring",
2779 "userpwd": "somestring"
2788 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2792 .. code-block:: javascript
2796 "fields": "somestring",
2798 "message": "somestring"
2819 Returns array of `Feed` objects.
2826 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2827 :widths: 20, 15, 10, 10, 10, 20, 30
2829 feedName | query | No | string | | |
2830 version | query | No | string | | |
2831 match | query | No | string | | |
2847 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2851 .. code-block:: javascript
2854 "asprClassification": "somestring",
2859 "feedDescription": "somestring",
2860 "feedId": "somestring",
2861 "feedName": "somestring",
2862 "feedVersion": "somestring",
2863 "formatUuid": "somestring",
2864 "lastMod": "2015-01-01T15:00:00.000Z",
2865 "logURL": "somestring",
2866 "owner": "somestring",
2867 "publishURL": "somestring",
2870 "dcaeLocationName": "somestring",
2871 "feedId": "somestring",
2872 "lastMod": "2015-01-01T15:00:00.000Z",
2873 "pubId": "somestring",
2875 "username": "somestring",
2876 "userpwd": "somestring"
2879 "dcaeLocationName": "somestring",
2880 "feedId": "somestring",
2881 "lastMod": "2015-01-01T15:00:00.000Z",
2882 "pubId": "somestring",
2884 "username": "somestring",
2885 "userpwd": "somestring"
2895 "dcaeLocationName": "somestring",
2896 "deliveryURL": "somestring",
2897 "feedId": "somestring",
2898 "lastMod": "2015-01-01T15:00:00.000Z",
2899 "logURL": "somestring",
2900 "owner": "somestring",
2902 "subId": "somestring",
2905 "username": "somestring",
2906 "userpwd": "somestring"
2913 "dcaeLocationName": "somestring",
2914 "deliveryURL": "somestring",
2915 "feedId": "somestring",
2916 "lastMod": "2015-01-01T15:00:00.000Z",
2917 "logURL": "somestring",
2918 "owner": "somestring",
2920 "subId": "somestring",
2923 "username": "somestring",
2924 "userpwd": "somestring"
2927 "subscribeURL": "somestring",
2937 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2941 .. code-block:: javascript
2945 "fields": "somestring",
2947 "message": "somestring"
2968 Update a `Feed` object, specified by id.
2975 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2976 :widths: 20, 15, 10, 10, 10, 20, 30
2978 id | path | Yes | string | | |
2994 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2998 .. code-block:: javascript
3001 "asprClassification": "somestring",
3006 "feedDescription": "somestring",
3007 "feedId": "somestring",
3008 "feedName": "somestring",
3009 "feedVersion": "somestring",
3010 "formatUuid": "somestring",
3011 "lastMod": "2015-01-01T15:00:00.000Z",
3012 "logURL": "somestring",
3013 "owner": "somestring",
3014 "publishURL": "somestring",
3017 "dcaeLocationName": "somestring",
3018 "feedId": "somestring",
3019 "lastMod": "2015-01-01T15:00:00.000Z",
3020 "pubId": "somestring",
3022 "username": "somestring",
3023 "userpwd": "somestring"
3026 "dcaeLocationName": "somestring",
3027 "feedId": "somestring",
3028 "lastMod": "2015-01-01T15:00:00.000Z",
3029 "pubId": "somestring",
3031 "username": "somestring",
3032 "userpwd": "somestring"
3042 "dcaeLocationName": "somestring",
3043 "deliveryURL": "somestring",
3044 "feedId": "somestring",
3045 "lastMod": "2015-01-01T15:00:00.000Z",
3046 "logURL": "somestring",
3047 "owner": "somestring",
3049 "subId": "somestring",
3052 "username": "somestring",
3053 "userpwd": "somestring"
3060 "dcaeLocationName": "somestring",
3061 "deliveryURL": "somestring",
3062 "feedId": "somestring",
3063 "lastMod": "2015-01-01T15:00:00.000Z",
3064 "logURL": "somestring",
3065 "owner": "somestring",
3067 "subId": "somestring",
3070 "username": "somestring",
3071 "userpwd": "somestring"
3074 "subscribeURL": "somestring",
3084 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3088 .. code-block:: javascript
3092 "fields": "somestring",
3094 "message": "somestring"
3104 Endpoint for this instance of DBCL. Returns health info.
3124 returns the `info` object
3140 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
3144 .. code-block:: javascript
3147 "accessKeyOwner": "somestring",
3148 "bridgeAdminTopic": "somestring",
3149 "dmaapName": "somestring",
3150 "drProvUrl": "somestring",
3151 "lastMod": "2015-01-01T15:00:00.000Z",
3152 "loggingUrl": "somestring",
3153 "nodeKey": "somestring",
3155 "topicNsRoot": "somestring",
3156 "version": "somestring"
3165 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3169 .. code-block:: javascript
3173 "fields": "somestring",
3175 "message": "somestring"
3185 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
3191 POST ``/mr_clients``
3192 --------------------
3198 Associate an MR_Client object to a Topic
3205 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.
3221 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3225 .. code-block:: javascript
3232 "clientIdentity": "somestring",
3233 "clientRole": "somestring",
3234 "dcaeLocationName": "somestring",
3235 "fqtn": "somestring",
3236 "lastMod": "2015-01-01T15:00:00.000Z",
3237 "mrClientId": "somestring",
3239 "topicURL": "somestring"
3248 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3252 .. code-block:: javascript
3256 "fields": "somestring",
3258 "message": "somestring"
3265 DELETE ``/mr_clients/{subId}``
3266 ------------------------------
3272 Delete an MR_Client object
3279 Delete a `MR_Client` object, specified by clientId
3286 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3287 :widths: 20, 15, 10, 10, 10, 20, 30
3289 subId | path | Yes | string | | |
3302 successful operation
3305 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3309 .. code-block:: javascript
3316 "clientIdentity": "somestring",
3317 "clientRole": "somestring",
3318 "dcaeLocationName": "somestring",
3319 "fqtn": "somestring",
3320 "lastMod": "2015-01-01T15:00:00.000Z",
3321 "mrClientId": "somestring",
3323 "topicURL": "somestring"
3332 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3336 .. code-block:: javascript
3343 "clientIdentity": "somestring",
3344 "clientRole": "somestring",
3345 "dcaeLocationName": "somestring",
3346 "fqtn": "somestring",
3347 "lastMod": "2015-01-01T15:00:00.000Z",
3348 "mrClientId": "somestring",
3350 "topicURL": "somestring"
3359 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3363 .. code-block:: javascript
3367 "fields": "somestring",
3369 "message": "somestring"
3383 return MR_Client details
3390 Returns array of `MR_Client` objects.
3406 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3410 .. code-block:: javascript
3417 "clientIdentity": "somestring",
3418 "clientRole": "somestring",
3419 "dcaeLocationName": "somestring",
3420 "fqtn": "somestring",
3421 "lastMod": "2015-01-01T15:00:00.000Z",
3422 "mrClientId": "somestring",
3424 "topicURL": "somestring"
3433 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3437 .. code-block:: javascript
3441 "fields": "somestring",
3443 "message": "somestring"
3450 GET ``/mr_clients/{subId}``
3451 ---------------------------
3457 return MR_Client details
3464 Retrieve a `MR_Client` object, specified by clientId
3471 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3472 :widths: 20, 15, 10, 10, 10, 20, 30
3474 subId | path | Yes | string | | |
3490 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3494 .. code-block:: javascript
3501 "clientIdentity": "somestring",
3502 "clientRole": "somestring",
3503 "dcaeLocationName": "somestring",
3504 "fqtn": "somestring",
3505 "lastMod": "2015-01-01T15:00:00.000Z",
3506 "mrClientId": "somestring",
3508 "topicURL": "somestring"
3517 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3521 .. code-block:: javascript
3525 "fields": "somestring",
3527 "message": "somestring"
3534 PUT ``/mr_clients/{clientId}``
3535 ------------------------------
3541 Update an MR_Client object
3548 Update a `MR_Client` object, specified by clientId
3555 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3556 :widths: 20, 15, 10, 10, 10, 20, 30
3558 clientId | path | Yes | string | | |
3574 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3578 .. code-block:: javascript
3585 "clientIdentity": "somestring",
3586 "clientRole": "somestring",
3587 "dcaeLocationName": "somestring",
3588 "fqtn": "somestring",
3589 "lastMod": "2015-01-01T15:00:00.000Z",
3590 "mrClientId": "somestring",
3592 "topicURL": "somestring"
3601 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3605 .. code-block:: javascript
3609 "fields": "somestring",
3611 "message": "somestring"
3621 Endpoint for a Message Router servers in a Cluster configuration
3627 POST ``/mr_clusters``
3628 ---------------------
3634 return MR_Cluster details
3641 Create an `MR_Cluster` object.
3657 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3661 .. code-block:: javascript
3664 "dcaeLocationName": "somestring",
3665 "fqdn": "somestring",
3666 "lastMod": "2015-01-01T15:00:00.000Z",
3667 "replicationGroup": "somestring",
3668 "sourceReplicationPort": "somestring",
3670 "targetReplicationPort": "somestring",
3671 "topicPort": "somestring",
3672 "topicProtocol": "somestring"
3681 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3685 .. code-block:: javascript
3689 "fields": "somestring",
3691 "message": "somestring"
3698 DELETE ``/mr_clusters/{clusterId}``
3699 -----------------------------------
3705 return MR_Cluster details
3712 Delete an `MR_Cluster` object, specified by clusterId.
3719 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3720 :widths: 20, 15, 10, 10, 10, 20, 30
3722 clusterId | path | Yes | string | | |
3735 successful operation
3738 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3742 .. code-block:: javascript
3745 "dcaeLocationName": "somestring",
3746 "fqdn": "somestring",
3747 "lastMod": "2015-01-01T15:00:00.000Z",
3748 "replicationGroup": "somestring",
3749 "sourceReplicationPort": "somestring",
3751 "targetReplicationPort": "somestring",
3752 "topicPort": "somestring",
3753 "topicProtocol": "somestring"
3762 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3766 .. code-block:: javascript
3769 "dcaeLocationName": "somestring",
3770 "fqdn": "somestring",
3771 "lastMod": "2015-01-01T15:00:00.000Z",
3772 "replicationGroup": "somestring",
3773 "sourceReplicationPort": "somestring",
3775 "targetReplicationPort": "somestring",
3776 "topicPort": "somestring",
3777 "topicProtocol": "somestring"
3786 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3790 .. code-block:: javascript
3794 "fields": "somestring",
3796 "message": "somestring"
3803 GET ``/mr_clusters/{clusterId}``
3804 --------------------------------
3810 return MR_Cluster details
3817 Retrieve an `MR_Cluster` object, specified by clusterId.
3824 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3825 :widths: 20, 15, 10, 10, 10, 20, 30
3827 clusterId | path | Yes | string | | |
3843 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3847 .. code-block:: javascript
3850 "dcaeLocationName": "somestring",
3851 "fqdn": "somestring",
3852 "lastMod": "2015-01-01T15:00:00.000Z",
3853 "replicationGroup": "somestring",
3854 "sourceReplicationPort": "somestring",
3856 "targetReplicationPort": "somestring",
3857 "topicPort": "somestring",
3858 "topicProtocol": "somestring"
3867 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3871 .. code-block:: javascript
3875 "fields": "somestring",
3877 "message": "somestring"
3884 GET ``/mr_clusters``
3885 --------------------
3891 return MR_Cluster details
3898 Returns array of `MR_Cluster` objects.
3914 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3918 .. code-block:: javascript
3921 "dcaeLocationName": "somestring",
3922 "fqdn": "somestring",
3923 "lastMod": "2015-01-01T15:00:00.000Z",
3924 "replicationGroup": "somestring",
3925 "sourceReplicationPort": "somestring",
3927 "targetReplicationPort": "somestring",
3928 "topicPort": "somestring",
3929 "topicProtocol": "somestring"
3938 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3942 .. code-block:: javascript
3946 "fields": "somestring",
3948 "message": "somestring"
3955 PUT ``/mr_clusters/{clusterId}``
3956 --------------------------------
3962 return MR_Cluster details
3969 Update an `MR_Cluster` object, specified by clusterId.
3976 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3977 :widths: 20, 15, 10, 10, 10, 20, 30
3979 clusterId | path | Yes | string | | |
3995 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3999 .. code-block:: javascript
4002 "dcaeLocationName": "somestring",
4003 "fqdn": "somestring",
4004 "lastMod": "2015-01-01T15:00:00.000Z",
4005 "replicationGroup": "somestring",
4006 "sourceReplicationPort": "somestring",
4008 "targetReplicationPort": "somestring",
4009 "topicPort": "somestring",
4010 "topicProtocol": "somestring"
4019 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4023 .. code-block:: javascript
4027 "fields": "somestring",
4029 "message": "somestring"
4039 Endpoint for retreiving MR Topics
4052 Create a Topic object
4059 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.
4066 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4067 :widths: 20, 15, 10, 10, 10, 20, 30
4069 useExisting | query | No | string | | |
4085 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4089 .. code-block:: javascript
4098 "clientIdentity": "somestring",
4099 "clientRole": "somestring",
4100 "dcaeLocationName": "somestring",
4101 "fqtn": "somestring",
4102 "lastMod": "2015-01-01T15:00:00.000Z",
4103 "mrClientId": "somestring",
4105 "topicURL": "somestring"
4112 "clientIdentity": "somestring",
4113 "clientRole": "somestring",
4114 "dcaeLocationName": "somestring",
4115 "fqtn": "somestring",
4116 "lastMod": "2015-01-01T15:00:00.000Z",
4117 "mrClientId": "somestring",
4119 "topicURL": "somestring"
4122 "formatUuid": "somestring",
4123 "fqtn": "somestring",
4124 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4125 "globalMrURL": "somestring",
4126 "lastMod": "2015-01-01T15:00:00.000Z",
4127 "owner": "somestring",
4128 "partitionCount": "somestring",
4129 "publisherRole": "somestring",
4130 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4131 "replicationCount": "somestring",
4133 "subscriberRole": "somestring",
4134 "tnxEnabled": "somestring",
4135 "topicDescription": "somestring",
4136 "topicName": "somestring",
4137 "version": "somestring"
4146 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4150 .. code-block:: javascript
4154 "fields": "somestring",
4156 "message": "somestring"
4163 DELETE ``/topics/{topicId}``
4164 ----------------------------
4170 return Topic details
4177 Delete a `Topic` object, identified by topicId
4184 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4185 :widths: 20, 15, 10, 10, 10, 20, 30
4187 topicId | path | Yes | string | | |
4200 successful operation
4203 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4207 .. code-block:: javascript
4216 "clientIdentity": "somestring",
4217 "clientRole": "somestring",
4218 "dcaeLocationName": "somestring",
4219 "fqtn": "somestring",
4220 "lastMod": "2015-01-01T15:00:00.000Z",
4221 "mrClientId": "somestring",
4223 "topicURL": "somestring"
4230 "clientIdentity": "somestring",
4231 "clientRole": "somestring",
4232 "dcaeLocationName": "somestring",
4233 "fqtn": "somestring",
4234 "lastMod": "2015-01-01T15:00:00.000Z",
4235 "mrClientId": "somestring",
4237 "topicURL": "somestring"
4240 "formatUuid": "somestring",
4241 "fqtn": "somestring",
4242 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4243 "globalMrURL": "somestring",
4244 "lastMod": "2015-01-01T15:00:00.000Z",
4245 "owner": "somestring",
4246 "partitionCount": "somestring",
4247 "publisherRole": "somestring",
4248 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4249 "replicationCount": "somestring",
4251 "subscriberRole": "somestring",
4252 "tnxEnabled": "somestring",
4253 "topicDescription": "somestring",
4254 "topicName": "somestring",
4255 "version": "somestring"
4264 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4268 .. code-block:: javascript
4277 "clientIdentity": "somestring",
4278 "clientRole": "somestring",
4279 "dcaeLocationName": "somestring",
4280 "fqtn": "somestring",
4281 "lastMod": "2015-01-01T15:00:00.000Z",
4282 "mrClientId": "somestring",
4284 "topicURL": "somestring"
4291 "clientIdentity": "somestring",
4292 "clientRole": "somestring",
4293 "dcaeLocationName": "somestring",
4294 "fqtn": "somestring",
4295 "lastMod": "2015-01-01T15:00:00.000Z",
4296 "mrClientId": "somestring",
4298 "topicURL": "somestring"
4301 "formatUuid": "somestring",
4302 "fqtn": "somestring",
4303 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4304 "globalMrURL": "somestring",
4305 "lastMod": "2015-01-01T15:00:00.000Z",
4306 "owner": "somestring",
4307 "partitionCount": "somestring",
4308 "publisherRole": "somestring",
4309 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4310 "replicationCount": "somestring",
4312 "subscriberRole": "somestring",
4313 "tnxEnabled": "somestring",
4314 "topicDescription": "somestring",
4315 "topicName": "somestring",
4316 "version": "somestring"
4325 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4329 .. code-block:: javascript
4333 "fields": "somestring",
4335 "message": "somestring"
4342 GET ``/topics/{topicId}``
4343 -------------------------
4349 return Topic details
4356 Retrieve a `Topic` object, identified by topicId
4363 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4364 :widths: 20, 15, 10, 10, 10, 20, 30
4366 topicId | path | Yes | string | | |
4382 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4386 .. code-block:: javascript
4395 "clientIdentity": "somestring",
4396 "clientRole": "somestring",
4397 "dcaeLocationName": "somestring",
4398 "fqtn": "somestring",
4399 "lastMod": "2015-01-01T15:00:00.000Z",
4400 "mrClientId": "somestring",
4402 "topicURL": "somestring"
4409 "clientIdentity": "somestring",
4410 "clientRole": "somestring",
4411 "dcaeLocationName": "somestring",
4412 "fqtn": "somestring",
4413 "lastMod": "2015-01-01T15:00:00.000Z",
4414 "mrClientId": "somestring",
4416 "topicURL": "somestring"
4419 "formatUuid": "somestring",
4420 "fqtn": "somestring",
4421 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4422 "globalMrURL": "somestring",
4423 "lastMod": "2015-01-01T15:00:00.000Z",
4424 "owner": "somestring",
4425 "partitionCount": "somestring",
4426 "publisherRole": "somestring",
4427 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4428 "replicationCount": "somestring",
4430 "subscriberRole": "somestring",
4431 "tnxEnabled": "somestring",
4432 "topicDescription": "somestring",
4433 "topicName": "somestring",
4434 "version": "somestring"
4443 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4447 .. code-block:: javascript
4451 "fields": "somestring",
4453 "message": "somestring"
4467 return Topic details
4474 Returns array of `Topic` objects.
4490 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4494 .. code-block:: javascript
4503 "clientIdentity": "somestring",
4504 "clientRole": "somestring",
4505 "dcaeLocationName": "somestring",
4506 "fqtn": "somestring",
4507 "lastMod": "2015-01-01T15:00:00.000Z",
4508 "mrClientId": "somestring",
4510 "topicURL": "somestring"
4517 "clientIdentity": "somestring",
4518 "clientRole": "somestring",
4519 "dcaeLocationName": "somestring",
4520 "fqtn": "somestring",
4521 "lastMod": "2015-01-01T15:00:00.000Z",
4522 "mrClientId": "somestring",
4524 "topicURL": "somestring"
4527 "formatUuid": "somestring",
4528 "fqtn": "somestring",
4529 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4530 "globalMrURL": "somestring",
4531 "lastMod": "2015-01-01T15:00:00.000Z",
4532 "owner": "somestring",
4533 "partitionCount": "somestring",
4534 "publisherRole": "somestring",
4535 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4536 "replicationCount": "somestring",
4538 "subscriberRole": "somestring",
4539 "tnxEnabled": "somestring",
4540 "topicDescription": "somestring",
4541 "topicName": "somestring",
4542 "version": "somestring"
4551 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4555 .. code-block:: javascript
4559 "fields": "somestring",
4561 "message": "somestring"
4568 PUT ``/topics/{topicId}``
4569 -------------------------
4575 return Topic details
4582 Update a `Topic` object, identified by topicId
4589 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4590 :widths: 20, 15, 10, 10, 10, 20, 30
4592 topicId | path | Yes | string | | |
4608 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4612 .. code-block:: javascript
4621 "clientIdentity": "somestring",
4622 "clientRole": "somestring",
4623 "dcaeLocationName": "somestring",
4624 "fqtn": "somestring",
4625 "lastMod": "2015-01-01T15:00:00.000Z",
4626 "mrClientId": "somestring",
4628 "topicURL": "somestring"
4635 "clientIdentity": "somestring",
4636 "clientRole": "somestring",
4637 "dcaeLocationName": "somestring",
4638 "fqtn": "somestring",
4639 "lastMod": "2015-01-01T15:00:00.000Z",
4640 "mrClientId": "somestring",
4642 "topicURL": "somestring"
4645 "formatUuid": "somestring",
4646 "fqtn": "somestring",
4647 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4648 "globalMrURL": "somestring",
4649 "lastMod": "2015-01-01T15:00:00.000Z",
4650 "owner": "somestring",
4651 "partitionCount": "somestring",
4652 "publisherRole": "somestring",
4653 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4654 "replicationCount": "somestring",
4656 "subscriberRole": "somestring",
4657 "tnxEnabled": "somestring",
4658 "topicDescription": "somestring",
4659 "topicName": "somestring",
4660 "version": "somestring"
4669 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4673 .. code-block:: javascript
4677 "fields": "somestring",
4679 "message": "somestring"
4688 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
4690 ApiError Model Structure
4691 ------------------------
4695 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4696 :widths: 20, 10, 15, 15, 30, 25
4698 code | No | integer | int32 | |
4699 fields | No | string | | |
4700 is2xx | No | boolean | | |
4701 message | No | string | | |
4703 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
4705 BrTopic Model Structure
4706 -----------------------
4710 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4711 :widths: 20, 10, 15, 15, 30, 25
4713 brSource | No | string | | |
4714 brTarget | No | string | | |
4715 mmAgentName | No | string | | |
4716 topicCount | No | integer | int32 | |
4718 .. _d_d15e2cee407536866c875375e3f705e0:
4720 DR_Node Model Structure
4721 -----------------------
4725 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4726 :widths: 20, 10, 15, 15, 30, 25
4728 dcaeLocationName | No | string | | |
4729 fqdn | No | string | | |
4730 hostName | No | string | | |
4731 lastMod | No | string | date-time | | datestamp for last update to this object
4732 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4733 version | No | string | | |
4735 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4737 DR_Pub Model Structure
4738 ----------------------
4742 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4743 :widths: 20, 10, 15, 15, 30, 25
4745 dcaeLocationName | No | string | | |
4746 feedId | No | string | | |
4747 lastMod | No | string | date-time | | datestamp for last update to this object
4748 pubId | No | string | | |
4749 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4750 username | No | string | | |
4751 userpwd | No | string | | |
4753 .. _d_48cf328d246f41e1d11a09251b042f02:
4755 DR_Sub Model Structure
4756 ----------------------
4760 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4761 :widths: 20, 10, 15, 15, 30, 25
4763 bytes | No | array of string | | |
4764 dcaeLocationName | No | string | | |
4765 deliveryURL | No | string | | |
4766 feedId | No | string | | |
4767 lastMod | No | string | date-time | | datestamp for last update to this object
4768 logURL | No | string | | |
4769 owner | No | string | | |
4770 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4771 subId | No | string | | |
4772 suspended | No | boolean | | |
4773 use100 | No | boolean | | |
4774 username | No | string | | |
4775 userpwd | No | string | | |
4777 .. _d_47d80e451933beb623fcf5257867cbcb:
4779 DcaeLocation Model Structure
4780 ----------------------------
4784 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4785 :widths: 20, 10, 15, 15, 30, 25
4787 central | No | boolean | | |
4788 clli | No | string | | |
4789 dcaeLayer | No | string | | |
4790 dcaeLocationName | No | string | | |
4791 lastMod | No | string | date-time | | datestamp for last update to this object
4792 local | No | boolean | | |
4793 openStackAvailabilityZone | No | string | | |
4794 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4795 subnet | No | string | | |
4797 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4799 Dmaap Model Structure
4800 ---------------------
4804 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4805 :widths: 20, 10, 15, 15, 30, 25
4807 accessKeyOwner | No | string | | |
4808 bridgeAdminTopic | No | string | | |
4809 dmaapName | No | string | | |
4810 drProvUrl | No | string | | |
4811 lastMod | No | string | date-time | | datestamp for last update to this object
4812 loggingUrl | No | string | | |
4813 nodeKey | No | string | | |
4814 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4815 topicNsRoot | No | string | | |
4816 version | No | string | | |
4818 .. _d_289ad39619725df26c9ff382d4c97c75:
4820 Feed Model Structure
4821 --------------------
4825 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4826 :widths: 20, 10, 15, 15, 30, 25
4828 asprClassification | No | string | | |
4829 bytes | No | array of string | | |
4830 feedDescription | No | string | | |
4831 feedId | No | string | | |
4832 feedName | No | string | | |
4833 feedVersion | No | string | | |
4834 formatUuid | No | string | | |
4835 lastMod | No | string | date-time | | datestamp for last update to this object
4836 logURL | No | string | | |
4837 owner | No | string | | |
4838 publishURL | No | string | | |
4839 pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
4840 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4841 subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
4842 subscribeURL | No | string | | |
4843 suspended | No | boolean | | |
4845 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4847 MR_Client Model Structure
4848 -------------------------
4852 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4853 :widths: 20, 10, 15, 15, 30, 25
4855 action | No | array of string | | | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
4856 clientIdentity | No | string | | | an AAF identity to be associated to an appropriate topic Role
4857 clientRole | No | string | | | an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility.
4858 dcaeLocationName | No | string | | | a tag indicating a logical deployment site
4859 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi
4860 lastMod | No | string | date-time | | datestamp for last update to this object
4861 mrClientId | No | string | | | a unique identifier generated by dbcapi for this client
4862 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4863 topicURL | No | string | | | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
4865 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4867 MR_Cluster Model Structure
4868 --------------------------
4872 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4873 :widths: 20, 10, 15, 15, 30, 25
4875 dcaeLocationName | No | string | | |
4876 fqdn | No | string | | |
4877 lastMod | No | string | date-time | |
4878 replicationGroup | No | string | | |
4879 sourceReplicationPort | No | string | | |
4880 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4881 targetReplicationPort | No | string | | |
4882 topicPort | No | string | | |
4883 topicProtocol | No | string | | |
4885 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4887 MirrorMaker Model Structure
4888 ---------------------------
4892 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4893 :widths: 20, 10, 15, 15, 30, 25
4895 lastMod | No | string | date-time | | datestamp for last update to this object
4896 mmName | No | string | | |
4897 sourceCluster | No | string | | |
4898 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4899 targetCluster | No | string | | |
4900 topicCount | No | integer | int32 | |
4901 topics | No | array of string | | |
4902 whitelistUpdateJSON | No | string | | |
4904 .. _d_2e99841971da81b9d240071b86bf168d:
4906 Topic Model Structure
4907 ---------------------
4911 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4912 :widths: 20, 10, 15, 15, 30, 25
4914 clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | | an array of `MR_Client` objects associated to this `Topic`
4915 formatUuid | No | string | | | a reference to an identifier that describes a data format used for this `Topic`
4916 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
4917 fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
4918 globalMrURL | No | string | | | the URL of an outside MR instance
4919 lastMod | No | string | date-time | | datestamp for last update to this object
4920 owner | No | string | | | a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity.
4921 partitionCount | No | string | | | the kafka attribute for specifying the number of partitions
4922 publisherRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
4923 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
4924 replicationCount | No | string | | | the kafka attribute for specifying replication within an `MR_Cluster` instance
4925 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4926 subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
4927 tnxEnabled | No | string | | |
4928 topicDescription | No | string | | | a description of what this Topic is used for
4929 topicName | No | string | | | the short name used by humans, and utilized to construct the `FQTN`
4930 version | No | string | | | a hook for any versioning needed for managing a `Topic` over time