1 DMaaP Bus Controller REST API 1.1.0
2 ===================================
7 Bus Controller provides an API for OpenDCAE components which need to provision
8 underlying DMaaP technologies (Data Router and Message Router).
9 Primary clients for this API are anticipated to be the OpenDCAE
10 Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
13 Objects managed by DMaaP are deployed in a dcaeLocation which is a
14 unique identifier for an OpenStack tenant for a dcaeLayer,
15 opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
17 A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
18 DMaaP is managed by a one or more stateless DMaaP Bus
19 Controller(s), though Bus Controller relies on PGaaS for
20 persistence. Each DMaaP has a single instance of Data Router,
21 which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
22 Clients of type DR_Pub generally publish to a DR_Node that is
23 local to its dcaeLocation. Routing for a Feed is determined by
24 the dcaelocation of its DR_Sub clients.
26 A DMaaP may have many Message Router instances. Each instance is
27 deployed as an MR_Cluster. One MR_Cluster is deployed at each
28 dcaeLocation. MR_Clients generally communicate to the
29 MR_Cluster at the same dcaeLocation. Replication of messages
30 between MR_Clusters is accomplished by MR Bridge, which is
31 provisioned by DMaaP Bus Controller based on Topic attributes.
33 Therefore, the role of DMaaP Bus Controller is to support other
34 DCAE infrastructure components to dynamically provision DMaaP
35 services on behalf of DMaaP clients, and to assist in any
36 management or discovery activity of its clients.
38 A convention of this API is to return JSON responses per
58 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
66 http://www.[host]:[port]/webapi
72 Endpoint for retrieving MR Bridge metrics
85 return BrTopic details
92 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.
99 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
100 :widths: 20, 15, 10, 10, 10, 20, 30
102 mmagent | query | No | string | | |
103 detail | query | No | boolean | | |
119 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
123 .. code-block:: javascript
126 "brSource": "somestring",
127 "brTarget": "somestring",
128 "mmAgentName": "somestring",
138 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
142 .. code-block:: javascript
146 "fields": "somestring",
148 "message": "somestring"
162 update MirrorMaker details
169 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.
176 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
177 :widths: 20, 15, 10, 10, 10, 20, 30
179 mmagent | query | No | string | | |
180 refresh | query | No | boolean | | |
181 split | query | No | boolean | | |
197 Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
201 .. code-block:: javascript
204 "brSource": "somestring",
205 "brTarget": "somestring",
206 "mmAgentName": "somestring",
216 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
220 .. code-block:: javascript
224 "fields": "somestring",
226 "message": "somestring"
236 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
242 POST ``/dcaeLocations``
243 -----------------------
249 return dcaeLocation details
256 Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
272 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
276 .. code-block:: javascript
280 "clli": "somestring",
281 "dcaeLayer": "somestring",
282 "dcaeLocationName": "somestring",
283 "lastMod": "2015-01-01T15:00:00.000Z",
285 "openStackAvailabilityZone": "somestring",
287 "subnet": "somestring"
296 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
300 .. code-block:: javascript
304 "fields": "somestring",
306 "message": "somestring"
313 DELETE ``/dcaeLocations/{locationName}``
314 ----------------------------------------
320 return dcaeLocation details
327 delete a dcaeLocation
334 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
335 :widths: 20, 15, 10, 10, 10, 20, 30
337 locationName | path | Yes | string | | |
353 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
357 .. code-block:: javascript
361 "clli": "somestring",
362 "dcaeLayer": "somestring",
363 "dcaeLocationName": "somestring",
364 "lastMod": "2015-01-01T15:00:00.000Z",
366 "openStackAvailabilityZone": "somestring",
368 "subnet": "somestring"
377 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
381 .. code-block:: javascript
385 "clli": "somestring",
386 "dcaeLayer": "somestring",
387 "dcaeLocationName": "somestring",
388 "lastMod": "2015-01-01T15:00:00.000Z",
390 "openStackAvailabilityZone": "somestring",
392 "subnet": "somestring"
401 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
405 .. code-block:: javascript
409 "fields": "somestring",
411 "message": "somestring"
418 GET ``/dcaeLocations/{locationName}``
419 -------------------------------------
425 return dcaeLocation details
432 Returns a specific `dcaeLocation` object with specified tag
439 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
440 :widths: 20, 15, 10, 10, 10, 20, 30
442 locationName | path | Yes | string | | |
458 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
462 .. code-block:: javascript
466 "clli": "somestring",
467 "dcaeLayer": "somestring",
468 "dcaeLocationName": "somestring",
469 "lastMod": "2015-01-01T15:00:00.000Z",
471 "openStackAvailabilityZone": "somestring",
473 "subnet": "somestring"
482 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
486 .. code-block:: javascript
490 "fields": "somestring",
492 "message": "somestring"
499 GET ``/dcaeLocations``
500 ----------------------
506 return dcaeLocation details
513 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).
529 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
533 .. code-block:: javascript
537 "clli": "somestring",
538 "dcaeLayer": "somestring",
539 "dcaeLocationName": "somestring",
540 "lastMod": "2015-01-01T15:00:00.000Z",
542 "openStackAvailabilityZone": "somestring",
544 "subnet": "somestring"
553 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
557 .. code-block:: javascript
561 "fields": "somestring",
563 "message": "somestring"
570 PUT ``/dcaeLocations/{locationName}``
571 -------------------------------------
577 return dcaeLocation details
584 update the openStackAvailabilityZone of a dcaeLocation
591 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
592 :widths: 20, 15, 10, 10, 10, 20, 30
594 locationName | path | Yes | string | | |
610 Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
614 .. code-block:: javascript
618 "clli": "somestring",
619 "dcaeLayer": "somestring",
620 "dcaeLocationName": "somestring",
621 "lastMod": "2015-01-01T15:00:00.000Z",
623 "openStackAvailabilityZone": "somestring",
625 "subnet": "somestring"
634 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
638 .. code-block:: javascript
642 "fields": "somestring",
644 "message": "somestring"
654 V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
674 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
690 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
694 .. code-block:: javascript
697 "accessKeyOwner": "somestring",
698 "bridgeAdminTopic": "somestring",
699 "dmaapName": "somestring",
700 "drProvUrl": "somestring",
701 "lastMod": "2015-01-01T15:00:00.000Z",
702 "loggingUrl": "somestring",
703 "nodeKey": "somestring",
705 "topicNsRoot": "somestring",
706 "version": "somestring"
715 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
719 .. code-block:: javascript
723 "fields": "somestring",
725 "message": "somestring"
746 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
762 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
766 .. code-block:: javascript
769 "accessKeyOwner": "somestring",
770 "bridgeAdminTopic": "somestring",
771 "dmaapName": "somestring",
772 "drProvUrl": "somestring",
773 "lastMod": "2015-01-01T15:00:00.000Z",
774 "loggingUrl": "somestring",
775 "nodeKey": "somestring",
777 "topicNsRoot": "somestring",
778 "version": "somestring"
787 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
791 .. code-block:: javascript
795 "fields": "somestring",
797 "message": "somestring"
818 returns the `dmaap` object, which contains system wide configuration settings
834 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
838 .. code-block:: javascript
841 "accessKeyOwner": "somestring",
842 "bridgeAdminTopic": "somestring",
843 "dmaapName": "somestring",
844 "drProvUrl": "somestring",
845 "lastMod": "2015-01-01T15:00:00.000Z",
846 "loggingUrl": "somestring",
847 "nodeKey": "somestring",
849 "topicNsRoot": "somestring",
850 "version": "somestring"
859 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
863 .. code-block:: javascript
867 "fields": "somestring",
869 "message": "somestring"
890 returns the `dmaap` object, which contains system wide configuration settings
906 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
910 .. code-block:: javascript
913 "accessKeyOwner": "somestring",
914 "bridgeAdminTopic": "somestring",
915 "dmaapName": "somestring",
916 "drProvUrl": "somestring",
917 "lastMod": "2015-01-01T15:00:00.000Z",
918 "loggingUrl": "somestring",
919 "nodeKey": "somestring",
921 "topicNsRoot": "somestring",
922 "version": "somestring"
931 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
935 .. code-block:: javascript
939 "fields": "somestring",
941 "message": "somestring"
962 Update system settings for *dcaeEnvironment*.
978 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
982 .. code-block:: javascript
985 "accessKeyOwner": "somestring",
986 "bridgeAdminTopic": "somestring",
987 "dmaapName": "somestring",
988 "drProvUrl": "somestring",
989 "lastMod": "2015-01-01T15:00:00.000Z",
990 "loggingUrl": "somestring",
991 "nodeKey": "somestring",
993 "topicNsRoot": "somestring",
994 "version": "somestring"
1003 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1007 .. code-block:: javascript
1011 "fields": "somestring",
1013 "message": "somestring"
1027 return dmaap details
1034 Update system settings for *dcaeEnvironment*.
1050 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1054 .. code-block:: javascript
1057 "accessKeyOwner": "somestring",
1058 "bridgeAdminTopic": "somestring",
1059 "dmaapName": "somestring",
1060 "drProvUrl": "somestring",
1061 "lastMod": "2015-01-01T15:00:00.000Z",
1062 "loggingUrl": "somestring",
1063 "nodeKey": "somestring",
1065 "topicNsRoot": "somestring",
1066 "version": "somestring"
1075 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1079 .. code-block:: javascript
1083 "fields": "somestring",
1085 "message": "somestring"
1095 Endpoint for a Data Router Node server
1108 return DR_Node details
1115 create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
1131 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1135 .. code-block:: javascript
1138 "dcaeLocationName": "somestring",
1139 "fqdn": "somestring",
1140 "hostName": "somestring",
1141 "lastMod": "2015-01-01T15:00:00.000Z",
1143 "version": "somestring"
1152 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1156 .. code-block:: javascript
1160 "fields": "somestring",
1162 "message": "somestring"
1169 DELETE ``/dr_nodes/{fqdn}``
1170 ---------------------------
1183 Delete a single `DR_Node` object.
1190 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1191 :widths: 20, 15, 10, 10, 10, 20, 30
1193 fqdn | path | Yes | string | | |
1206 successful operation
1209 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1213 .. code-block:: javascript
1216 "dcaeLocationName": "somestring",
1217 "fqdn": "somestring",
1218 "hostName": "somestring",
1219 "lastMod": "2015-01-01T15:00:00.000Z",
1221 "version": "somestring"
1230 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1234 .. code-block:: javascript
1237 "dcaeLocationName": "somestring",
1238 "fqdn": "somestring",
1239 "hostName": "somestring",
1240 "lastMod": "2015-01-01T15:00:00.000Z",
1242 "version": "somestring"
1251 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1255 .. code-block:: javascript
1259 "fields": "somestring",
1261 "message": "somestring"
1268 GET ``/dr_nodes/{fqdn}``
1269 ------------------------
1275 return DR_Node details
1282 Retrieve a single `DR_Node` object.
1289 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1290 :widths: 20, 15, 10, 10, 10, 20, 30
1292 fqdn | path | Yes | string | | |
1308 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1312 .. code-block:: javascript
1315 "dcaeLocationName": "somestring",
1316 "fqdn": "somestring",
1317 "hostName": "somestring",
1318 "lastMod": "2015-01-01T15:00:00.000Z",
1320 "version": "somestring"
1329 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1333 .. code-block:: javascript
1337 "fields": "somestring",
1339 "message": "somestring"
1353 return DR_Node details
1360 Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
1376 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1380 .. code-block:: javascript
1383 "dcaeLocationName": "somestring",
1384 "fqdn": "somestring",
1385 "hostName": "somestring",
1386 "lastMod": "2015-01-01T15:00:00.000Z",
1388 "version": "somestring"
1397 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1401 .. code-block:: javascript
1405 "fields": "somestring",
1407 "message": "somestring"
1414 PUT ``/dr_nodes/{fqdn}``
1415 ------------------------
1421 return DR_Node details
1428 Update a single `DR_Node` object.
1435 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1436 :widths: 20, 15, 10, 10, 10, 20, 30
1438 fqdn | path | Yes | string | | |
1454 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1458 .. code-block:: javascript
1461 "dcaeLocationName": "somestring",
1462 "fqdn": "somestring",
1463 "hostName": "somestring",
1464 "lastMod": "2015-01-01T15:00:00.000Z",
1466 "version": "somestring"
1475 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1479 .. code-block:: javascript
1483 "fields": "somestring",
1485 "message": "somestring"
1495 Endpoint for a Data Router client that implements a Publisher
1508 return DR_Pub details
1515 create a DR Publisher in the specified environment.
1531 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1535 .. code-block:: javascript
1538 "dcaeLocationName": "somestring",
1539 "feedId": "somestring",
1540 "lastMod": "2015-01-01T15:00:00.000Z",
1541 "pubId": "somestring",
1543 "username": "somestring",
1544 "userpwd": "somestring"
1553 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1557 .. code-block:: javascript
1561 "fields": "somestring",
1563 "message": "somestring"
1570 DELETE ``/dr_pubs/{pubId}``
1571 ---------------------------
1577 return DR_Pub details
1584 delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1591 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1592 :widths: 20, 15, 10, 10, 10, 20, 30
1594 pubId | path | Yes | string | | |
1607 successful operation
1610 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1614 .. code-block:: javascript
1617 "dcaeLocationName": "somestring",
1618 "feedId": "somestring",
1619 "lastMod": "2015-01-01T15:00:00.000Z",
1620 "pubId": "somestring",
1622 "username": "somestring",
1623 "userpwd": "somestring"
1632 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1636 .. code-block:: javascript
1639 "dcaeLocationName": "somestring",
1640 "feedId": "somestring",
1641 "lastMod": "2015-01-01T15:00:00.000Z",
1642 "pubId": "somestring",
1644 "username": "somestring",
1645 "userpwd": "somestring"
1654 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1658 .. code-block:: javascript
1662 "fields": "somestring",
1664 "message": "somestring"
1671 GET ``/dr_pubs/{pubId}``
1672 ------------------------
1678 return DR_Pub details
1685 returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1692 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1693 :widths: 20, 15, 10, 10, 10, 20, 30
1695 pubId | path | Yes | string | | |
1711 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1715 .. code-block:: javascript
1718 "dcaeLocationName": "somestring",
1719 "feedId": "somestring",
1720 "lastMod": "2015-01-01T15:00:00.000Z",
1721 "pubId": "somestring",
1723 "username": "somestring",
1724 "userpwd": "somestring"
1733 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1737 .. code-block:: javascript
1741 "fields": "somestring",
1743 "message": "somestring"
1757 return DR_Pub details
1764 Returns array of `DR_Pub` objects. Add filter for feedId.
1780 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1784 .. code-block:: javascript
1787 "dcaeLocationName": "somestring",
1788 "feedId": "somestring",
1789 "lastMod": "2015-01-01T15:00:00.000Z",
1790 "pubId": "somestring",
1792 "username": "somestring",
1793 "userpwd": "somestring"
1802 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1806 .. code-block:: javascript
1810 "fields": "somestring",
1812 "message": "somestring"
1819 PUT ``/dr_pubs/{pubId}``
1820 ------------------------
1826 return DR_Pub details
1833 update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
1840 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1841 :widths: 20, 15, 10, 10, 10, 20, 30
1843 pubId | path | Yes | string | | |
1859 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1863 .. code-block:: javascript
1866 "dcaeLocationName": "somestring",
1867 "feedId": "somestring",
1868 "lastMod": "2015-01-01T15:00:00.000Z",
1869 "pubId": "somestring",
1871 "username": "somestring",
1872 "userpwd": "somestring"
1881 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1885 .. code-block:: javascript
1889 "fields": "somestring",
1891 "message": "somestring"
1901 Endpoint for a Data Router client that implements a Subscriber
1914 return DR_Sub details
1921 Create a `DR_Sub` object.
1937 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
1941 .. code-block:: javascript
1948 "dcaeLocationName": "somestring",
1949 "deliveryURL": "somestring",
1950 "feedId": "somestring",
1951 "lastMod": "2015-01-01T15:00:00.000Z",
1952 "logURL": "somestring",
1953 "owner": "somestring",
1955 "subId": "somestring",
1958 "username": "somestring",
1959 "userpwd": "somestring"
1968 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1972 .. code-block:: javascript
1976 "fields": "somestring",
1978 "message": "somestring"
1985 DELETE ``/dr_subs/{subId}``
1986 ---------------------------
1992 return DR_Sub details
1999 Delete a `DR_Sub` object, selected by subId
2006 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2007 :widths: 20, 15, 10, 10, 10, 20, 30
2009 subId | path | Yes | string | | |
2025 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2029 .. code-block:: javascript
2036 "dcaeLocationName": "somestring",
2037 "deliveryURL": "somestring",
2038 "feedId": "somestring",
2039 "lastMod": "2015-01-01T15:00:00.000Z",
2040 "logURL": "somestring",
2041 "owner": "somestring",
2043 "subId": "somestring",
2046 "username": "somestring",
2047 "userpwd": "somestring"
2056 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2060 .. code-block:: javascript
2064 "fields": "somestring",
2066 "message": "somestring"
2073 GET ``/dr_subs/{subId}``
2074 ------------------------
2080 return DR_Sub details
2087 Retrieve a `DR_Sub` object, selected by subId
2094 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2095 :widths: 20, 15, 10, 10, 10, 20, 30
2097 subId | path | Yes | string | | |
2113 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2117 .. code-block:: javascript
2124 "dcaeLocationName": "somestring",
2125 "deliveryURL": "somestring",
2126 "feedId": "somestring",
2127 "lastMod": "2015-01-01T15:00:00.000Z",
2128 "logURL": "somestring",
2129 "owner": "somestring",
2131 "subId": "somestring",
2134 "username": "somestring",
2135 "userpwd": "somestring"
2144 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2148 .. code-block:: javascript
2152 "fields": "somestring",
2154 "message": "somestring"
2168 return DR_Sub details
2175 Returns array of `DR_Sub` objects. Add filter for feedId.
2191 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2195 .. code-block:: javascript
2202 "dcaeLocationName": "somestring",
2203 "deliveryURL": "somestring",
2204 "feedId": "somestring",
2205 "lastMod": "2015-01-01T15:00:00.000Z",
2206 "logURL": "somestring",
2207 "owner": "somestring",
2209 "subId": "somestring",
2212 "username": "somestring",
2213 "userpwd": "somestring"
2222 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2226 .. code-block:: javascript
2230 "fields": "somestring",
2232 "message": "somestring"
2239 PUT ``/dr_subs/{subId}``
2240 ------------------------
2246 return DR_Sub details
2253 Update a `DR_Sub` object, selected by subId
2260 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2261 :widths: 20, 15, 10, 10, 10, 20, 30
2263 subId | path | Yes | string | | |
2279 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2283 .. code-block:: javascript
2290 "dcaeLocationName": "somestring",
2291 "deliveryURL": "somestring",
2292 "feedId": "somestring",
2293 "lastMod": "2015-01-01T15:00:00.000Z",
2294 "logURL": "somestring",
2295 "owner": "somestring",
2297 "subId": "somestring",
2300 "username": "somestring",
2301 "userpwd": "somestring"
2310 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2314 .. code-block:: javascript
2318 "fields": "somestring",
2320 "message": "somestring"
2330 Endpoint for a Data Router Feed
2350 Create a of `Feed` object.
2357 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2358 :widths: 20, 15, 10, 10, 10, 20, 30
2360 useExisting | query | No | string | | |
2376 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2380 .. code-block:: javascript
2383 "asprClassification": "somestring",
2388 "feedDescription": "somestring",
2389 "feedId": "somestring",
2390 "feedName": "somestring",
2391 "feedVersion": "somestring",
2392 "formatUuid": "somestring",
2393 "lastMod": "2015-01-01T15:00:00.000Z",
2394 "logURL": "somestring",
2395 "owner": "somestring",
2396 "publishURL": "somestring",
2399 "dcaeLocationName": "somestring",
2400 "feedId": "somestring",
2401 "lastMod": "2015-01-01T15:00:00.000Z",
2402 "pubId": "somestring",
2404 "username": "somestring",
2405 "userpwd": "somestring"
2408 "dcaeLocationName": "somestring",
2409 "feedId": "somestring",
2410 "lastMod": "2015-01-01T15:00:00.000Z",
2411 "pubId": "somestring",
2413 "username": "somestring",
2414 "userpwd": "somestring"
2424 "dcaeLocationName": "somestring",
2425 "deliveryURL": "somestring",
2426 "feedId": "somestring",
2427 "lastMod": "2015-01-01T15:00:00.000Z",
2428 "logURL": "somestring",
2429 "owner": "somestring",
2431 "subId": "somestring",
2434 "username": "somestring",
2435 "userpwd": "somestring"
2442 "dcaeLocationName": "somestring",
2443 "deliveryURL": "somestring",
2444 "feedId": "somestring",
2445 "lastMod": "2015-01-01T15:00:00.000Z",
2446 "logURL": "somestring",
2447 "owner": "somestring",
2449 "subId": "somestring",
2452 "username": "somestring",
2453 "userpwd": "somestring"
2456 "subscribeURL": "somestring",
2466 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2470 .. code-block:: javascript
2474 "fields": "somestring",
2476 "message": "somestring"
2483 DELETE ``/feeds/{id}``
2484 ----------------------
2497 Delete a `Feed` object, specified by id.
2504 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2505 :widths: 20, 15, 10, 10, 10, 20, 30
2507 id | path | Yes | string | | |
2520 successful operation
2523 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2527 .. code-block:: javascript
2530 "asprClassification": "somestring",
2535 "feedDescription": "somestring",
2536 "feedId": "somestring",
2537 "feedName": "somestring",
2538 "feedVersion": "somestring",
2539 "formatUuid": "somestring",
2540 "lastMod": "2015-01-01T15:00:00.000Z",
2541 "logURL": "somestring",
2542 "owner": "somestring",
2543 "publishURL": "somestring",
2546 "dcaeLocationName": "somestring",
2547 "feedId": "somestring",
2548 "lastMod": "2015-01-01T15:00:00.000Z",
2549 "pubId": "somestring",
2551 "username": "somestring",
2552 "userpwd": "somestring"
2555 "dcaeLocationName": "somestring",
2556 "feedId": "somestring",
2557 "lastMod": "2015-01-01T15:00:00.000Z",
2558 "pubId": "somestring",
2560 "username": "somestring",
2561 "userpwd": "somestring"
2571 "dcaeLocationName": "somestring",
2572 "deliveryURL": "somestring",
2573 "feedId": "somestring",
2574 "lastMod": "2015-01-01T15:00:00.000Z",
2575 "logURL": "somestring",
2576 "owner": "somestring",
2578 "subId": "somestring",
2581 "username": "somestring",
2582 "userpwd": "somestring"
2589 "dcaeLocationName": "somestring",
2590 "deliveryURL": "somestring",
2591 "feedId": "somestring",
2592 "lastMod": "2015-01-01T15:00:00.000Z",
2593 "logURL": "somestring",
2594 "owner": "somestring",
2596 "subId": "somestring",
2599 "username": "somestring",
2600 "userpwd": "somestring"
2603 "subscribeURL": "somestring",
2613 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2617 .. code-block:: javascript
2620 "asprClassification": "somestring",
2625 "feedDescription": "somestring",
2626 "feedId": "somestring",
2627 "feedName": "somestring",
2628 "feedVersion": "somestring",
2629 "formatUuid": "somestring",
2630 "lastMod": "2015-01-01T15:00:00.000Z",
2631 "logURL": "somestring",
2632 "owner": "somestring",
2633 "publishURL": "somestring",
2636 "dcaeLocationName": "somestring",
2637 "feedId": "somestring",
2638 "lastMod": "2015-01-01T15:00:00.000Z",
2639 "pubId": "somestring",
2641 "username": "somestring",
2642 "userpwd": "somestring"
2645 "dcaeLocationName": "somestring",
2646 "feedId": "somestring",
2647 "lastMod": "2015-01-01T15:00:00.000Z",
2648 "pubId": "somestring",
2650 "username": "somestring",
2651 "userpwd": "somestring"
2661 "dcaeLocationName": "somestring",
2662 "deliveryURL": "somestring",
2663 "feedId": "somestring",
2664 "lastMod": "2015-01-01T15:00:00.000Z",
2665 "logURL": "somestring",
2666 "owner": "somestring",
2668 "subId": "somestring",
2671 "username": "somestring",
2672 "userpwd": "somestring"
2679 "dcaeLocationName": "somestring",
2680 "deliveryURL": "somestring",
2681 "feedId": "somestring",
2682 "lastMod": "2015-01-01T15:00:00.000Z",
2683 "logURL": "somestring",
2684 "owner": "somestring",
2686 "subId": "somestring",
2689 "username": "somestring",
2690 "userpwd": "somestring"
2693 "subscribeURL": "somestring",
2703 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2707 .. code-block:: javascript
2711 "fields": "somestring",
2713 "message": "somestring"
2734 Retrieve a `Feed` object, specified by id.
2741 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2742 :widths: 20, 15, 10, 10, 10, 20, 30
2744 id | path | Yes | string | | |
2760 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2764 .. code-block:: javascript
2767 "dcaeLocationName": "somestring",
2768 "feedId": "somestring",
2769 "lastMod": "2015-01-01T15:00:00.000Z",
2770 "pubId": "somestring",
2772 "username": "somestring",
2773 "userpwd": "somestring"
2782 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2786 .. code-block:: javascript
2790 "fields": "somestring",
2792 "message": "somestring"
2813 Returns array of `Feed` objects.
2820 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2821 :widths: 20, 15, 10, 10, 10, 20, 30
2823 feedName | query | No | string | | |
2824 version | query | No | string | | |
2825 match | query | No | string | | |
2841 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2845 .. code-block:: javascript
2848 "asprClassification": "somestring",
2853 "feedDescription": "somestring",
2854 "feedId": "somestring",
2855 "feedName": "somestring",
2856 "feedVersion": "somestring",
2857 "formatUuid": "somestring",
2858 "lastMod": "2015-01-01T15:00:00.000Z",
2859 "logURL": "somestring",
2860 "owner": "somestring",
2861 "publishURL": "somestring",
2864 "dcaeLocationName": "somestring",
2865 "feedId": "somestring",
2866 "lastMod": "2015-01-01T15:00:00.000Z",
2867 "pubId": "somestring",
2869 "username": "somestring",
2870 "userpwd": "somestring"
2873 "dcaeLocationName": "somestring",
2874 "feedId": "somestring",
2875 "lastMod": "2015-01-01T15:00:00.000Z",
2876 "pubId": "somestring",
2878 "username": "somestring",
2879 "userpwd": "somestring"
2889 "dcaeLocationName": "somestring",
2890 "deliveryURL": "somestring",
2891 "feedId": "somestring",
2892 "lastMod": "2015-01-01T15:00:00.000Z",
2893 "logURL": "somestring",
2894 "owner": "somestring",
2896 "subId": "somestring",
2899 "username": "somestring",
2900 "userpwd": "somestring"
2907 "dcaeLocationName": "somestring",
2908 "deliveryURL": "somestring",
2909 "feedId": "somestring",
2910 "lastMod": "2015-01-01T15:00:00.000Z",
2911 "logURL": "somestring",
2912 "owner": "somestring",
2914 "subId": "somestring",
2917 "username": "somestring",
2918 "userpwd": "somestring"
2921 "subscribeURL": "somestring",
2931 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2935 .. code-block:: javascript
2939 "fields": "somestring",
2941 "message": "somestring"
2962 Update a `Feed` object, specified by id.
2969 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2970 :widths: 20, 15, 10, 10, 10, 20, 30
2972 id | path | Yes | string | | |
2988 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2992 .. code-block:: javascript
2995 "asprClassification": "somestring",
3000 "feedDescription": "somestring",
3001 "feedId": "somestring",
3002 "feedName": "somestring",
3003 "feedVersion": "somestring",
3004 "formatUuid": "somestring",
3005 "lastMod": "2015-01-01T15:00:00.000Z",
3006 "logURL": "somestring",
3007 "owner": "somestring",
3008 "publishURL": "somestring",
3011 "dcaeLocationName": "somestring",
3012 "feedId": "somestring",
3013 "lastMod": "2015-01-01T15:00:00.000Z",
3014 "pubId": "somestring",
3016 "username": "somestring",
3017 "userpwd": "somestring"
3020 "dcaeLocationName": "somestring",
3021 "feedId": "somestring",
3022 "lastMod": "2015-01-01T15:00:00.000Z",
3023 "pubId": "somestring",
3025 "username": "somestring",
3026 "userpwd": "somestring"
3036 "dcaeLocationName": "somestring",
3037 "deliveryURL": "somestring",
3038 "feedId": "somestring",
3039 "lastMod": "2015-01-01T15:00:00.000Z",
3040 "logURL": "somestring",
3041 "owner": "somestring",
3043 "subId": "somestring",
3046 "username": "somestring",
3047 "userpwd": "somestring"
3054 "dcaeLocationName": "somestring",
3055 "deliveryURL": "somestring",
3056 "feedId": "somestring",
3057 "lastMod": "2015-01-01T15:00:00.000Z",
3058 "logURL": "somestring",
3059 "owner": "somestring",
3061 "subId": "somestring",
3064 "username": "somestring",
3065 "userpwd": "somestring"
3068 "subscribeURL": "somestring",
3078 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3082 .. code-block:: javascript
3086 "fields": "somestring",
3088 "message": "somestring"
3098 Endpoint for this instance of DBCL. Returns health info.
3118 returns the `info` object
3134 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
3138 .. code-block:: javascript
3141 "accessKeyOwner": "somestring",
3142 "bridgeAdminTopic": "somestring",
3143 "dmaapName": "somestring",
3144 "drProvUrl": "somestring",
3145 "lastMod": "2015-01-01T15:00:00.000Z",
3146 "loggingUrl": "somestring",
3147 "nodeKey": "somestring",
3149 "topicNsRoot": "somestring",
3150 "version": "somestring"
3159 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3163 .. code-block:: javascript
3167 "fields": "somestring",
3169 "message": "somestring"
3179 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
3185 POST ``/mr_clients``
3186 --------------------
3192 Associate an MR_Client object to a Topic
3199 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.
3215 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3219 .. code-block:: javascript
3226 "clientIdentity": "somestring",
3227 "clientRole": "somestring",
3228 "dcaeLocationName": "somestring",
3229 "fqtn": "somestring",
3230 "lastMod": "2015-01-01T15:00:00.000Z",
3231 "mrClientId": "somestring",
3233 "topicURL": "somestring"
3242 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3246 .. code-block:: javascript
3250 "fields": "somestring",
3252 "message": "somestring"
3259 DELETE ``/mr_clients/{subId}``
3260 ------------------------------
3266 Delete an MR_Client object
3273 Delete a `MR_Client` object, specified by clientId
3280 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3281 :widths: 20, 15, 10, 10, 10, 20, 30
3283 subId | path | Yes | string | | |
3296 successful operation
3299 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3303 .. code-block:: javascript
3310 "clientIdentity": "somestring",
3311 "clientRole": "somestring",
3312 "dcaeLocationName": "somestring",
3313 "fqtn": "somestring",
3314 "lastMod": "2015-01-01T15:00:00.000Z",
3315 "mrClientId": "somestring",
3317 "topicURL": "somestring"
3326 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3330 .. code-block:: javascript
3337 "clientIdentity": "somestring",
3338 "clientRole": "somestring",
3339 "dcaeLocationName": "somestring",
3340 "fqtn": "somestring",
3341 "lastMod": "2015-01-01T15:00:00.000Z",
3342 "mrClientId": "somestring",
3344 "topicURL": "somestring"
3353 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3357 .. code-block:: javascript
3361 "fields": "somestring",
3363 "message": "somestring"
3377 return MR_Client details
3384 Returns array of `MR_Client` objects.
3400 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3404 .. code-block:: javascript
3411 "clientIdentity": "somestring",
3412 "clientRole": "somestring",
3413 "dcaeLocationName": "somestring",
3414 "fqtn": "somestring",
3415 "lastMod": "2015-01-01T15:00:00.000Z",
3416 "mrClientId": "somestring",
3418 "topicURL": "somestring"
3427 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3431 .. code-block:: javascript
3435 "fields": "somestring",
3437 "message": "somestring"
3444 GET ``/mr_clients/{subId}``
3445 ---------------------------
3451 return MR_Client details
3458 Retrieve a `MR_Client` object, specified by clientId
3465 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3466 :widths: 20, 15, 10, 10, 10, 20, 30
3468 subId | path | Yes | string | | |
3484 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3488 .. code-block:: javascript
3495 "clientIdentity": "somestring",
3496 "clientRole": "somestring",
3497 "dcaeLocationName": "somestring",
3498 "fqtn": "somestring",
3499 "lastMod": "2015-01-01T15:00:00.000Z",
3500 "mrClientId": "somestring",
3502 "topicURL": "somestring"
3511 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3515 .. code-block:: javascript
3519 "fields": "somestring",
3521 "message": "somestring"
3528 PUT ``/mr_clients/{clientId}``
3529 ------------------------------
3535 Update an MR_Client object
3542 Update a `MR_Client` object, specified by clientId
3549 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3550 :widths: 20, 15, 10, 10, 10, 20, 30
3552 clientId | path | Yes | string | | |
3568 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3572 .. code-block:: javascript
3579 "clientIdentity": "somestring",
3580 "clientRole": "somestring",
3581 "dcaeLocationName": "somestring",
3582 "fqtn": "somestring",
3583 "lastMod": "2015-01-01T15:00:00.000Z",
3584 "mrClientId": "somestring",
3586 "topicURL": "somestring"
3595 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3599 .. code-block:: javascript
3603 "fields": "somestring",
3605 "message": "somestring"
3615 Endpoint for a Message Router servers in a Cluster configuration
3621 POST ``/mr_clusters``
3622 ---------------------
3628 return MR_Cluster details
3635 Create an `MR_Cluster` object.
3651 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3655 .. code-block:: javascript
3658 "dcaeLocationName": "somestring",
3659 "fqdn": "somestring",
3660 "lastMod": "2015-01-01T15:00:00.000Z",
3661 "replicationGroup": "somestring",
3662 "sourceReplicationPort": "somestring",
3664 "targetReplicationPort": "somestring",
3665 "topicPort": "somestring",
3666 "topicProtocol": "somestring"
3675 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3679 .. code-block:: javascript
3683 "fields": "somestring",
3685 "message": "somestring"
3692 DELETE ``/mr_clusters/{clusterId}``
3693 -----------------------------------
3699 return MR_Cluster details
3706 Delete an `MR_Cluster` object, specified by clusterId.
3713 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3714 :widths: 20, 15, 10, 10, 10, 20, 30
3716 clusterId | path | Yes | string | | |
3729 successful operation
3732 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3736 .. code-block:: javascript
3739 "dcaeLocationName": "somestring",
3740 "fqdn": "somestring",
3741 "lastMod": "2015-01-01T15:00:00.000Z",
3742 "replicationGroup": "somestring",
3743 "sourceReplicationPort": "somestring",
3745 "targetReplicationPort": "somestring",
3746 "topicPort": "somestring",
3747 "topicProtocol": "somestring"
3756 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3760 .. code-block:: javascript
3763 "dcaeLocationName": "somestring",
3764 "fqdn": "somestring",
3765 "lastMod": "2015-01-01T15:00:00.000Z",
3766 "replicationGroup": "somestring",
3767 "sourceReplicationPort": "somestring",
3769 "targetReplicationPort": "somestring",
3770 "topicPort": "somestring",
3771 "topicProtocol": "somestring"
3780 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3784 .. code-block:: javascript
3788 "fields": "somestring",
3790 "message": "somestring"
3797 GET ``/mr_clusters/{clusterId}``
3798 --------------------------------
3804 return MR_Cluster details
3811 Retrieve an `MR_Cluster` object, specified by clusterId.
3818 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3819 :widths: 20, 15, 10, 10, 10, 20, 30
3821 clusterId | path | Yes | string | | |
3837 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3841 .. code-block:: javascript
3844 "dcaeLocationName": "somestring",
3845 "fqdn": "somestring",
3846 "lastMod": "2015-01-01T15:00:00.000Z",
3847 "replicationGroup": "somestring",
3848 "sourceReplicationPort": "somestring",
3850 "targetReplicationPort": "somestring",
3851 "topicPort": "somestring",
3852 "topicProtocol": "somestring"
3861 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3865 .. code-block:: javascript
3869 "fields": "somestring",
3871 "message": "somestring"
3878 GET ``/mr_clusters``
3879 --------------------
3885 return MR_Cluster details
3892 Returns array of `MR_Cluster` objects.
3908 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3912 .. code-block:: javascript
3915 "dcaeLocationName": "somestring",
3916 "fqdn": "somestring",
3917 "lastMod": "2015-01-01T15:00:00.000Z",
3918 "replicationGroup": "somestring",
3919 "sourceReplicationPort": "somestring",
3921 "targetReplicationPort": "somestring",
3922 "topicPort": "somestring",
3923 "topicProtocol": "somestring"
3932 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3936 .. code-block:: javascript
3940 "fields": "somestring",
3942 "message": "somestring"
3949 PUT ``/mr_clusters/{clusterId}``
3950 --------------------------------
3956 return MR_Cluster details
3963 Update an `MR_Cluster` object, specified by clusterId.
3970 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3971 :widths: 20, 15, 10, 10, 10, 20, 30
3973 clusterId | path | Yes | string | | |
3989 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3993 .. code-block:: javascript
3996 "dcaeLocationName": "somestring",
3997 "fqdn": "somestring",
3998 "lastMod": "2015-01-01T15:00:00.000Z",
3999 "replicationGroup": "somestring",
4000 "sourceReplicationPort": "somestring",
4002 "targetReplicationPort": "somestring",
4003 "topicPort": "somestring",
4004 "topicProtocol": "somestring"
4013 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4017 .. code-block:: javascript
4021 "fields": "somestring",
4023 "message": "somestring"
4033 Endpoint for retrieving MR Topics
4046 Create a Topic object
4053 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.
4060 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4061 :widths: 20, 15, 10, 10, 10, 20, 30
4063 useExisting | query | No | string | | |
4079 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4083 .. code-block:: javascript
4092 "clientIdentity": "somestring",
4093 "clientRole": "somestring",
4094 "dcaeLocationName": "somestring",
4095 "fqtn": "somestring",
4096 "lastMod": "2015-01-01T15:00:00.000Z",
4097 "mrClientId": "somestring",
4099 "topicURL": "somestring"
4106 "clientIdentity": "somestring",
4107 "clientRole": "somestring",
4108 "dcaeLocationName": "somestring",
4109 "fqtn": "somestring",
4110 "lastMod": "2015-01-01T15:00:00.000Z",
4111 "mrClientId": "somestring",
4113 "topicURL": "somestring"
4116 "formatUuid": "somestring",
4117 "fqtn": "somestring",
4118 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4119 "globalMrURL": "somestring",
4120 "lastMod": "2015-01-01T15:00:00.000Z",
4121 "owner": "somestring",
4122 "partitionCount": "somestring",
4123 "publisherRole": "somestring",
4124 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4125 "replicationCount": "somestring",
4127 "subscriberRole": "somestring",
4128 "tnxEnabled": "somestring",
4129 "topicDescription": "somestring",
4130 "topicName": "somestring",
4131 "version": "somestring"
4140 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4144 .. code-block:: javascript
4148 "fields": "somestring",
4150 "message": "somestring"
4157 DELETE ``/topics/{topicId}``
4158 ----------------------------
4164 return Topic details
4171 Delete a `Topic` object, identified by topicId
4178 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4179 :widths: 20, 15, 10, 10, 10, 20, 30
4181 topicId | path | Yes | string | | |
4194 successful operation
4197 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4201 .. code-block:: javascript
4210 "clientIdentity": "somestring",
4211 "clientRole": "somestring",
4212 "dcaeLocationName": "somestring",
4213 "fqtn": "somestring",
4214 "lastMod": "2015-01-01T15:00:00.000Z",
4215 "mrClientId": "somestring",
4217 "topicURL": "somestring"
4224 "clientIdentity": "somestring",
4225 "clientRole": "somestring",
4226 "dcaeLocationName": "somestring",
4227 "fqtn": "somestring",
4228 "lastMod": "2015-01-01T15:00:00.000Z",
4229 "mrClientId": "somestring",
4231 "topicURL": "somestring"
4234 "formatUuid": "somestring",
4235 "fqtn": "somestring",
4236 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4237 "globalMrURL": "somestring",
4238 "lastMod": "2015-01-01T15:00:00.000Z",
4239 "owner": "somestring",
4240 "partitionCount": "somestring",
4241 "publisherRole": "somestring",
4242 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4243 "replicationCount": "somestring",
4245 "subscriberRole": "somestring",
4246 "tnxEnabled": "somestring",
4247 "topicDescription": "somestring",
4248 "topicName": "somestring",
4249 "version": "somestring"
4258 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4262 .. code-block:: javascript
4271 "clientIdentity": "somestring",
4272 "clientRole": "somestring",
4273 "dcaeLocationName": "somestring",
4274 "fqtn": "somestring",
4275 "lastMod": "2015-01-01T15:00:00.000Z",
4276 "mrClientId": "somestring",
4278 "topicURL": "somestring"
4285 "clientIdentity": "somestring",
4286 "clientRole": "somestring",
4287 "dcaeLocationName": "somestring",
4288 "fqtn": "somestring",
4289 "lastMod": "2015-01-01T15:00:00.000Z",
4290 "mrClientId": "somestring",
4292 "topicURL": "somestring"
4295 "formatUuid": "somestring",
4296 "fqtn": "somestring",
4297 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4298 "globalMrURL": "somestring",
4299 "lastMod": "2015-01-01T15:00:00.000Z",
4300 "owner": "somestring",
4301 "partitionCount": "somestring",
4302 "publisherRole": "somestring",
4303 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4304 "replicationCount": "somestring",
4306 "subscriberRole": "somestring",
4307 "tnxEnabled": "somestring",
4308 "topicDescription": "somestring",
4309 "topicName": "somestring",
4310 "version": "somestring"
4319 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4323 .. code-block:: javascript
4327 "fields": "somestring",
4329 "message": "somestring"
4336 GET ``/topics/{topicId}``
4337 -------------------------
4343 return Topic details
4350 Retrieve a `Topic` object, identified by topicId
4357 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4358 :widths: 20, 15, 10, 10, 10, 20, 30
4360 topicId | path | Yes | string | | |
4376 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4380 .. code-block:: javascript
4389 "clientIdentity": "somestring",
4390 "clientRole": "somestring",
4391 "dcaeLocationName": "somestring",
4392 "fqtn": "somestring",
4393 "lastMod": "2015-01-01T15:00:00.000Z",
4394 "mrClientId": "somestring",
4396 "topicURL": "somestring"
4403 "clientIdentity": "somestring",
4404 "clientRole": "somestring",
4405 "dcaeLocationName": "somestring",
4406 "fqtn": "somestring",
4407 "lastMod": "2015-01-01T15:00:00.000Z",
4408 "mrClientId": "somestring",
4410 "topicURL": "somestring"
4413 "formatUuid": "somestring",
4414 "fqtn": "somestring",
4415 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4416 "globalMrURL": "somestring",
4417 "lastMod": "2015-01-01T15:00:00.000Z",
4418 "owner": "somestring",
4419 "partitionCount": "somestring",
4420 "publisherRole": "somestring",
4421 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4422 "replicationCount": "somestring",
4424 "subscriberRole": "somestring",
4425 "tnxEnabled": "somestring",
4426 "topicDescription": "somestring",
4427 "topicName": "somestring",
4428 "version": "somestring"
4437 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4441 .. code-block:: javascript
4445 "fields": "somestring",
4447 "message": "somestring"
4461 return Topic details
4468 Returns array of `Topic` objects.
4484 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4488 .. code-block:: javascript
4497 "clientIdentity": "somestring",
4498 "clientRole": "somestring",
4499 "dcaeLocationName": "somestring",
4500 "fqtn": "somestring",
4501 "lastMod": "2015-01-01T15:00:00.000Z",
4502 "mrClientId": "somestring",
4504 "topicURL": "somestring"
4511 "clientIdentity": "somestring",
4512 "clientRole": "somestring",
4513 "dcaeLocationName": "somestring",
4514 "fqtn": "somestring",
4515 "lastMod": "2015-01-01T15:00:00.000Z",
4516 "mrClientId": "somestring",
4518 "topicURL": "somestring"
4521 "formatUuid": "somestring",
4522 "fqtn": "somestring",
4523 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4524 "globalMrURL": "somestring",
4525 "lastMod": "2015-01-01T15:00:00.000Z",
4526 "owner": "somestring",
4527 "partitionCount": "somestring",
4528 "publisherRole": "somestring",
4529 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4530 "replicationCount": "somestring",
4532 "subscriberRole": "somestring",
4533 "tnxEnabled": "somestring",
4534 "topicDescription": "somestring",
4535 "topicName": "somestring",
4536 "version": "somestring"
4545 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4549 .. code-block:: javascript
4553 "fields": "somestring",
4555 "message": "somestring"
4562 PUT ``/topics/{topicId}``
4563 -------------------------
4569 return Topic details
4576 Update a `Topic` object, identified by topicId
4583 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4584 :widths: 20, 15, 10, 10, 10, 20, 30
4586 topicId | path | Yes | string | | |
4602 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
4606 .. code-block:: javascript
4615 "clientIdentity": "somestring",
4616 "clientRole": "somestring",
4617 "dcaeLocationName": "somestring",
4618 "fqtn": "somestring",
4619 "lastMod": "2015-01-01T15:00:00.000Z",
4620 "mrClientId": "somestring",
4622 "topicURL": "somestring"
4629 "clientIdentity": "somestring",
4630 "clientRole": "somestring",
4631 "dcaeLocationName": "somestring",
4632 "fqtn": "somestring",
4633 "lastMod": "2015-01-01T15:00:00.000Z",
4634 "mrClientId": "somestring",
4636 "topicURL": "somestring"
4639 "formatUuid": "somestring",
4640 "fqtn": "somestring",
4641 "fqtnStyle": "FQTN_NOT_SPECIFIED",
4642 "globalMrURL": "somestring",
4643 "lastMod": "2015-01-01T15:00:00.000Z",
4644 "owner": "somestring",
4645 "partitionCount": "somestring",
4646 "publisherRole": "somestring",
4647 "replicationCase": "REPLICATION_NOT_SPECIFIED",
4648 "replicationCount": "somestring",
4650 "subscriberRole": "somestring",
4651 "tnxEnabled": "somestring",
4652 "topicDescription": "somestring",
4653 "topicName": "somestring",
4654 "version": "somestring"
4663 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4667 .. code-block:: javascript
4671 "fields": "somestring",
4673 "message": "somestring"
4682 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
4684 ApiError Model Structure
4685 ------------------------
4689 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4690 :widths: 20, 10, 15, 15, 30, 25
4692 code | No | integer | int32 | |
4693 fields | No | string | | |
4694 is2xx | No | boolean | | |
4695 message | No | string | | |
4697 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
4699 BrTopic Model Structure
4700 -----------------------
4704 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4705 :widths: 20, 10, 15, 15, 30, 25
4707 brSource | No | string | | |
4708 brTarget | No | string | | |
4709 mmAgentName | No | string | | |
4710 topicCount | No | integer | int32 | |
4712 .. _d_d15e2cee407536866c875375e3f705e0:
4714 DR_Node Model Structure
4715 -----------------------
4719 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4720 :widths: 20, 10, 15, 15, 30, 25
4722 dcaeLocationName | No | string | | |
4723 fqdn | No | string | | |
4724 hostName | No | string | | |
4725 lastMod | No | string | date-time | | datestamp for last update to this object
4726 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4727 version | No | string | | |
4729 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4731 DR_Pub Model Structure
4732 ----------------------
4736 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4737 :widths: 20, 10, 15, 15, 30, 25
4739 dcaeLocationName | No | string | | |
4740 feedId | No | string | | |
4741 lastMod | No | string | date-time | | datestamp for last update to this object
4742 pubId | No | string | | |
4743 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4744 username | No | string | | |
4745 userpwd | No | string | | |
4747 .. _d_48cf328d246f41e1d11a09251b042f02:
4749 DR_Sub Model Structure
4750 ----------------------
4754 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4755 :widths: 20, 10, 15, 15, 30, 25
4757 bytes | No | array of string | | |
4758 dcaeLocationName | No | string | | |
4759 deliveryURL | No | string | | |
4760 feedId | No | string | | |
4761 lastMod | No | string | date-time | | datestamp for last update to this object
4762 logURL | No | string | | |
4763 owner | No | string | | |
4764 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4765 subId | No | string | | |
4766 suspended | No | boolean | | |
4767 use100 | No | boolean | | |
4768 username | No | string | | |
4769 userpwd | No | string | | |
4771 .. _d_47d80e451933beb623fcf5257867cbcb:
4773 DcaeLocation Model Structure
4774 ----------------------------
4778 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4779 :widths: 20, 10, 15, 15, 30, 25
4781 central | No | boolean | | |
4782 clli | No | string | | |
4783 dcaeLayer | No | string | | |
4784 dcaeLocationName | No | string | | |
4785 lastMod | No | string | date-time | | datestamp for last update to this object
4786 local | No | boolean | | |
4787 openStackAvailabilityZone | No | string | | |
4788 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4789 subnet | No | string | | |
4791 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4793 Dmaap Model Structure
4794 ---------------------
4798 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4799 :widths: 20, 10, 15, 15, 30, 25
4801 accessKeyOwner | No | string | | |
4802 bridgeAdminTopic | No | string | | |
4803 dmaapName | No | string | | |
4804 drProvUrl | No | string | | |
4805 lastMod | No | string | date-time | | datestamp for last update to this object
4806 loggingUrl | No | string | | |
4807 nodeKey | No | string | | |
4808 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4809 topicNsRoot | No | string | | |
4810 version | No | string | | |
4812 .. _d_289ad39619725df26c9ff382d4c97c75:
4814 Feed Model Structure
4815 --------------------
4819 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4820 :widths: 20, 10, 15, 15, 30, 25
4822 asprClassification | No | string | | |
4823 bytes | No | array of string | | |
4824 feedDescription | No | string | | |
4825 feedId | No | string | | |
4826 feedName | No | string | | |
4827 feedVersion | No | string | | |
4828 formatUuid | No | string | | |
4829 lastMod | No | string | date-time | | datestamp for last update to this object
4830 logURL | No | string | | |
4831 owner | No | string | | |
4832 publishURL | No | string | | |
4833 pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
4834 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4835 subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
4836 subscribeURL | No | string | | |
4837 suspended | No | boolean | | |
4839 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4841 MR_Client Model Structure
4842 -------------------------
4846 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4847 :widths: 20, 10, 15, 15, 30, 25
4849 action | No | array of string | | | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
4850 clientIdentity | No | string | | | an AAF identity to be associated to an appropriate topic Role
4851 clientRole | No | string | | | an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility.
4852 dcaeLocationName | No | string | | | a tag indicating a logical deployment site
4853 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi
4854 lastMod | No | string | date-time | | datestamp for last update to this object
4855 mrClientId | No | string | | | a unique identifier generated by dbcapi for this client
4856 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4857 topicURL | No | string | | | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
4859 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4861 MR_Cluster Model Structure
4862 --------------------------
4866 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4867 :widths: 20, 10, 15, 15, 30, 25
4869 dcaeLocationName | No | string | | |
4870 fqdn | No | string | | |
4871 lastMod | No | string | date-time | |
4872 replicationGroup | No | string | | |
4873 sourceReplicationPort | No | string | | |
4874 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4875 targetReplicationPort | No | string | | |
4876 topicPort | No | string | | |
4877 topicProtocol | No | string | | |
4879 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4881 MirrorMaker Model Structure
4882 ---------------------------
4886 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4887 :widths: 20, 10, 15, 15, 30, 25
4889 lastMod | No | string | date-time | | datestamp for last update to this object
4890 mmName | No | string | | |
4891 sourceCluster | No | string | | |
4892 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4893 targetCluster | No | string | | |
4894 topicCount | No | integer | int32 | |
4895 topics | No | array of string | | |
4896 whitelistUpdateJSON | No | string | | |
4898 .. _d_2e99841971da81b9d240071b86bf168d:
4900 Topic Model Structure
4901 ---------------------
4905 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4906 :widths: 20, 10, 15, 15, 30, 25
4908 clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | | an array of `MR_Client` objects associated to this `Topic`
4909 formatUuid | No | string | | | a reference to an identifier that describes a data format used for this `Topic`
4910 fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
4911 fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
4912 globalMrURL | No | string | | | the URL of an outside MR instance
4913 lastMod | No | string | date-time | | datestamp for last update to this object
4914 owner | No | string | | | a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity.
4915 partitionCount | No | string | | | the kafka attribute for specifying the number of partitions
4916 publisherRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
4917 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
4918 replicationCount | No | string | | | the kafka attribute for specifying replication within an `MR_Cluster` instance
4919 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4920 subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
4921 tnxEnabled | No | string | | |
4922 topicDescription | No | string | | | a description of what this Topic is used for
4923 topicName | No | string | | | the short name used by humans, and utilized to construct the `FQTN`
4924 version | No | string | | | a hook for any versioning needed for managing a `Topic` over time