1 DMaaP Bus Controller REST API 1.1.0
2 ===================================
11 provides an API for OpenDCAE components which need to provision
12 underlying DMaaP technologies (Data Router and Message Router).
13 Primary clients for this API are anticipated to be the OpenDCAE
14 Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
17 Objects managed by DMaaP are deployed in a dcaeLocation which is a
18 unique identifier for an OpenStack tenant for a dcaeLayer,
19 opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
21 A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
22 DMaaP is managed by a one or more stateless DMaaP Bus
23 Controller(s), though Bus Controller relies on PGaaS for
24 persistence. Each DMaaP has a single instance of Data Router,
25 which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
26 Clients of type DR_Pub generally publish to a DR_Node that is
27 local to its dcaeLocation. Routing for a Feed is determined by
28 the dcaelocation of its DR_Sub clients.
30 A DMaaP may have many Message Router instances. Each instance is
31 deployed as an MR_Cluster. One MR_Cluster is deployed at each
32 dcaeLocation. MR_Clients generally communicate to the
33 MR_Cluster at the same dcaeLocation. Replication of messages
34 between MR_Clusters is accomplished by MR Bridge, which is
35 provioned by DMaaP Bus Controller based on Topic attributes.
37 Therefore, the role of DMaaP Bus Controller is to support other
38 DCAE infrastructure components to dynamically provision DMaaP
39 services on behalf of DMaaP clients, and to assist in any
40 management or discovery activity of its clients.
42 A convention of this API is to return JSON responses per
62 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
70 http://www.[host]:[port]/webapi
71 https://www.[host]:[port]/webapi
77 Endpoint for retreiving MR Bridge metrics
90 return BrTopic details
97 Returns array of `BrTopic` objects. If source and target query params are specified, only report on that bridge. If detail param is true, list topics names, else just a count is returned.
104 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
105 :widths: 20, 15, 10, 10, 10, 20, 30
107 mmagent | query | No | string | | |
108 detail | query | No | boolean | | |
124 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
128 .. code-block:: javascript
131 "accessKeyOwner": "somestring",
132 "bridgeAdminTopic": "somestring",
133 "dmaapName": "somestring",
134 "drProvUrl": "somestring",
135 "lastMod": "2015-01-01T15:00:00.000Z",
136 "loggingUrl": "somestring",
137 "nodeKey": "somestring",
140 "topicNsRoot": "somestring",
141 "version": "somestring"
150 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
154 .. code-block:: javascript
158 "fields": "somestring",
160 "message": "somestring"
174 update MirrorMaker details
181 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.
188 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
189 :widths: 20, 15, 10, 10, 10, 20, 30
191 mmagent | query | No | string | | |
192 refresh | query | No | boolean | | |
193 split | query | No | boolean | | |
209 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
213 .. code-block:: javascript
216 "accessKeyOwner": "somestring",
217 "bridgeAdminTopic": "somestring",
218 "dmaapName": "somestring",
219 "drProvUrl": "somestring",
220 "lastMod": "2015-01-01T15:00:00.000Z",
221 "loggingUrl": "somestring",
222 "nodeKey": "somestring",
225 "topicNsRoot": "somestring",
226 "version": "somestring"
235 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
239 .. code-block:: javascript
243 "fields": "somestring",
245 "message": "somestring"
255 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
261 POST ``/dcaeLocations``
262 -----------------------
268 return dcaeLocation details
275 Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
291 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
295 .. code-block:: javascript
298 "accessKeyOwner": "somestring",
299 "bridgeAdminTopic": "somestring",
300 "dmaapName": "somestring",
301 "drProvUrl": "somestring",
302 "lastMod": "2015-01-01T15:00:00.000Z",
303 "loggingUrl": "somestring",
304 "nodeKey": "somestring",
307 "topicNsRoot": "somestring",
308 "version": "somestring"
317 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
321 .. code-block:: javascript
325 "fields": "somestring",
327 "message": "somestring"
334 DELETE ``/dcaeLocations/{locationName}``
335 ----------------------------------------
341 return dcaeLocation details
348 delete a dcaeLocation
355 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
356 :widths: 20, 15, 10, 10, 10, 20, 30
358 locationName | path | Yes | string | | |
374 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
378 .. code-block:: javascript
381 "accessKeyOwner": "somestring",
382 "bridgeAdminTopic": "somestring",
383 "dmaapName": "somestring",
384 "drProvUrl": "somestring",
385 "lastMod": "2015-01-01T15:00:00.000Z",
386 "loggingUrl": "somestring",
387 "nodeKey": "somestring",
390 "topicNsRoot": "somestring",
391 "version": "somestring"
400 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
404 .. code-block:: javascript
407 "accessKeyOwner": "somestring",
408 "bridgeAdminTopic": "somestring",
409 "dmaapName": "somestring",
410 "drProvUrl": "somestring",
411 "lastMod": "2015-01-01T15:00:00.000Z",
412 "loggingUrl": "somestring",
413 "nodeKey": "somestring",
416 "topicNsRoot": "somestring",
417 "version": "somestring"
426 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
430 .. code-block:: javascript
434 "fields": "somestring",
436 "message": "somestring"
443 GET ``/dcaeLocations/{locationName}``
444 -------------------------------------
450 return dcaeLocation details
457 Returns a specific `dcaeLocation` object with specified tag
464 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
465 :widths: 20, 15, 10, 10, 10, 20, 30
467 locationName | path | Yes | string | | |
483 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
487 .. code-block:: javascript
490 "accessKeyOwner": "somestring",
491 "bridgeAdminTopic": "somestring",
492 "dmaapName": "somestring",
493 "drProvUrl": "somestring",
494 "lastMod": "2015-01-01T15:00:00.000Z",
495 "loggingUrl": "somestring",
496 "nodeKey": "somestring",
499 "topicNsRoot": "somestring",
500 "version": "somestring"
509 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
513 .. code-block:: javascript
517 "fields": "somestring",
519 "message": "somestring"
526 GET ``/dcaeLocations``
527 ----------------------
533 return dcaeLocation details
540 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).
556 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
560 .. code-block:: javascript
563 "accessKeyOwner": "somestring",
564 "bridgeAdminTopic": "somestring",
565 "dmaapName": "somestring",
566 "drProvUrl": "somestring",
567 "lastMod": "2015-01-01T15:00:00.000Z",
568 "loggingUrl": "somestring",
569 "nodeKey": "somestring",
572 "topicNsRoot": "somestring",
573 "version": "somestring"
582 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
586 .. code-block:: javascript
590 "fields": "somestring",
592 "message": "somestring"
599 PUT ``/dcaeLocations/{locationName}``
600 -------------------------------------
606 return dcaeLocation details
613 update the openStackAvailabilityZone of a dcaeLocation
620 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
621 :widths: 20, 15, 10, 10, 10, 20, 30
623 locationName | path | Yes | string | | |
639 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
643 .. code-block:: javascript
646 "accessKeyOwner": "somestring",
647 "bridgeAdminTopic": "somestring",
648 "dmaapName": "somestring",
649 "drProvUrl": "somestring",
650 "lastMod": "2015-01-01T15:00:00.000Z",
651 "loggingUrl": "somestring",
652 "nodeKey": "somestring",
655 "topicNsRoot": "somestring",
656 "version": "somestring"
665 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
669 .. code-block:: javascript
673 "fields": "somestring",
675 "message": "somestring"
685 V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
705 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
721 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
725 .. code-block:: javascript
728 "accessKeyOwner": "somestring",
729 "bridgeAdminTopic": "somestring",
730 "dmaapName": "somestring",
731 "drProvUrl": "somestring",
732 "lastMod": "2015-01-01T15:00:00.000Z",
733 "loggingUrl": "somestring",
734 "nodeKey": "somestring",
737 "topicNsRoot": "somestring",
738 "version": "somestring"
747 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
751 .. code-block:: javascript
755 "fields": "somestring",
757 "message": "somestring"
778 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
794 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
798 .. code-block:: javascript
801 "accessKeyOwner": "somestring",
802 "bridgeAdminTopic": "somestring",
803 "dmaapName": "somestring",
804 "drProvUrl": "somestring",
805 "lastMod": "2015-01-01T15:00:00.000Z",
806 "loggingUrl": "somestring",
807 "nodeKey": "somestring",
810 "topicNsRoot": "somestring",
811 "version": "somestring"
820 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
824 .. code-block:: javascript
828 "fields": "somestring",
830 "message": "somestring"
851 returns the `dmaap` object, which contains system wide configuration settings
867 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
871 .. code-block:: javascript
874 "accessKeyOwner": "somestring",
875 "bridgeAdminTopic": "somestring",
876 "dmaapName": "somestring",
877 "drProvUrl": "somestring",
878 "lastMod": "2015-01-01T15:00:00.000Z",
879 "loggingUrl": "somestring",
880 "nodeKey": "somestring",
883 "topicNsRoot": "somestring",
884 "version": "somestring"
893 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
897 .. code-block:: javascript
901 "fields": "somestring",
903 "message": "somestring"
924 returns the `dmaap` object, which contains system wide configuration settings
940 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
944 .. code-block:: javascript
947 "accessKeyOwner": "somestring",
948 "bridgeAdminTopic": "somestring",
949 "dmaapName": "somestring",
950 "drProvUrl": "somestring",
951 "lastMod": "2015-01-01T15:00:00.000Z",
952 "loggingUrl": "somestring",
953 "nodeKey": "somestring",
956 "topicNsRoot": "somestring",
957 "version": "somestring"
966 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
970 .. code-block:: javascript
974 "fields": "somestring",
976 "message": "somestring"
997 Update system settings for *dcaeEnvironment*.
1013 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1017 .. code-block:: javascript
1020 "accessKeyOwner": "somestring",
1021 "bridgeAdminTopic": "somestring",
1022 "dmaapName": "somestring",
1023 "drProvUrl": "somestring",
1024 "lastMod": "2015-01-01T15:00:00.000Z",
1025 "loggingUrl": "somestring",
1026 "nodeKey": "somestring",
1028 "statusValid": true,
1029 "topicNsRoot": "somestring",
1030 "version": "somestring"
1039 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1043 .. code-block:: javascript
1047 "fields": "somestring",
1049 "message": "somestring"
1063 return dmaap details
1070 Update system settings for *dcaeEnvironment*.
1086 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
1090 .. code-block:: javascript
1093 "accessKeyOwner": "somestring",
1094 "bridgeAdminTopic": "somestring",
1095 "dmaapName": "somestring",
1096 "drProvUrl": "somestring",
1097 "lastMod": "2015-01-01T15:00:00.000Z",
1098 "loggingUrl": "somestring",
1099 "nodeKey": "somestring",
1101 "statusValid": true,
1102 "topicNsRoot": "somestring",
1103 "version": "somestring"
1112 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1116 .. code-block:: javascript
1120 "fields": "somestring",
1122 "message": "somestring"
1132 Endpoint for a Data Router Node server
1145 return DR_Node details
1152 create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
1168 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1172 .. code-block:: javascript
1175 "dcaeLocationName": "somestring",
1176 "fqdn": "somestring",
1177 "hostName": "somestring",
1178 "lastMod": "2015-01-01T15:00:00.000Z",
1180 "statusValid": true,
1181 "version": "somestring"
1190 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1194 .. code-block:: javascript
1198 "fields": "somestring",
1200 "message": "somestring"
1207 DELETE ``/dr_nodes/{fqdn}``
1208 ---------------------------
1221 Delete a single `DR_Node` object.
1228 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1229 :widths: 20, 15, 10, 10, 10, 20, 30
1231 fqdn | path | Yes | string | | |
1244 successful operation
1247 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1251 .. code-block:: javascript
1254 "dcaeLocationName": "somestring",
1255 "fqdn": "somestring",
1256 "hostName": "somestring",
1257 "lastMod": "2015-01-01T15:00:00.000Z",
1259 "statusValid": true,
1260 "version": "somestring"
1269 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1273 .. code-block:: javascript
1276 "dcaeLocationName": "somestring",
1277 "fqdn": "somestring",
1278 "hostName": "somestring",
1279 "lastMod": "2015-01-01T15:00:00.000Z",
1281 "statusValid": true,
1282 "version": "somestring"
1291 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1295 .. code-block:: javascript
1299 "fields": "somestring",
1301 "message": "somestring"
1308 GET ``/dr_nodes/{fqdn}``
1309 ------------------------
1315 return DR_Node details
1322 Retrieve a single `DR_Node` object.
1329 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1330 :widths: 20, 15, 10, 10, 10, 20, 30
1332 fqdn | path | Yes | string | | |
1348 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1352 .. code-block:: javascript
1355 "dcaeLocationName": "somestring",
1356 "fqdn": "somestring",
1357 "hostName": "somestring",
1358 "lastMod": "2015-01-01T15:00:00.000Z",
1360 "statusValid": true,
1361 "version": "somestring"
1370 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1374 .. code-block:: javascript
1378 "fields": "somestring",
1380 "message": "somestring"
1394 return DR_Node details
1401 Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
1417 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1421 .. code-block:: javascript
1424 "dcaeLocationName": "somestring",
1425 "fqdn": "somestring",
1426 "hostName": "somestring",
1427 "lastMod": "2015-01-01T15:00:00.000Z",
1429 "statusValid": true,
1430 "version": "somestring"
1439 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1443 .. code-block:: javascript
1447 "fields": "somestring",
1449 "message": "somestring"
1456 PUT ``/dr_nodes/{fqdn}``
1457 ------------------------
1463 return DR_Node details
1470 Update a single `DR_Node` object.
1477 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1478 :widths: 20, 15, 10, 10, 10, 20, 30
1480 fqdn | path | Yes | string | | |
1496 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1500 .. code-block:: javascript
1503 "dcaeLocationName": "somestring",
1504 "fqdn": "somestring",
1505 "hostName": "somestring",
1506 "lastMod": "2015-01-01T15:00:00.000Z",
1508 "statusValid": true,
1509 "version": "somestring"
1518 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1522 .. code-block:: javascript
1526 "fields": "somestring",
1528 "message": "somestring"
1538 Endpoint for a Data Router client that implements a Publisher
1551 return DR_Pub details
1558 create a DR Publisher in the specified environment.
1574 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1578 .. code-block:: javascript
1581 "dcaeLocationName": "somestring",
1582 "feedId": "somestring",
1583 "lastMod": "2015-01-01T15:00:00.000Z",
1584 "pubId": "somestring",
1586 "statusValid": true,
1587 "username": "somestring",
1588 "userpwd": "somestring"
1597 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1601 .. code-block:: javascript
1605 "fields": "somestring",
1607 "message": "somestring"
1614 DELETE ``/dr_pubs/{pubId}``
1615 ---------------------------
1621 return DR_Pub details
1628 delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1635 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1636 :widths: 20, 15, 10, 10, 10, 20, 30
1638 pubId | path | Yes | string | | |
1651 successful operation
1654 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1658 .. code-block:: javascript
1661 "dcaeLocationName": "somestring",
1662 "feedId": "somestring",
1663 "lastMod": "2015-01-01T15:00:00.000Z",
1664 "pubId": "somestring",
1666 "statusValid": true,
1667 "username": "somestring",
1668 "userpwd": "somestring"
1677 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1681 .. code-block:: javascript
1684 "dcaeLocationName": "somestring",
1685 "feedId": "somestring",
1686 "lastMod": "2015-01-01T15:00:00.000Z",
1687 "pubId": "somestring",
1689 "statusValid": true,
1690 "username": "somestring",
1691 "userpwd": "somestring"
1700 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1704 .. code-block:: javascript
1708 "fields": "somestring",
1710 "message": "somestring"
1717 GET ``/dr_pubs/{pubId}``
1718 ------------------------
1724 return DR_Pub details
1731 returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1738 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1739 :widths: 20, 15, 10, 10, 10, 20, 30
1741 pubId | path | Yes | string | | |
1757 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1761 .. code-block:: javascript
1764 "dcaeLocationName": "somestring",
1765 "feedId": "somestring",
1766 "lastMod": "2015-01-01T15:00:00.000Z",
1767 "pubId": "somestring",
1769 "statusValid": true,
1770 "username": "somestring",
1771 "userpwd": "somestring"
1780 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1784 .. code-block:: javascript
1788 "fields": "somestring",
1790 "message": "somestring"
1804 return DR_Pub details
1811 Returns array of `DR_Pub` objects. Add filter for feedId.
1827 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1831 .. code-block:: javascript
1834 "dcaeLocationName": "somestring",
1835 "feedId": "somestring",
1836 "lastMod": "2015-01-01T15:00:00.000Z",
1837 "pubId": "somestring",
1839 "statusValid": true,
1840 "username": "somestring",
1841 "userpwd": "somestring"
1850 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1854 .. code-block:: javascript
1858 "fields": "somestring",
1860 "message": "somestring"
1867 PUT ``/dr_pubs/{pubId}``
1868 ------------------------
1874 return DR_Pub details
1881 update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
1888 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1889 :widths: 20, 15, 10, 10, 10, 20, 30
1891 pubId | path | Yes | string | | |
1907 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1911 .. code-block:: javascript
1914 "dcaeLocationName": "somestring",
1915 "feedId": "somestring",
1916 "lastMod": "2015-01-01T15:00:00.000Z",
1917 "pubId": "somestring",
1919 "statusValid": true,
1920 "username": "somestring",
1921 "userpwd": "somestring"
1930 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1934 .. code-block:: javascript
1938 "fields": "somestring",
1940 "message": "somestring"
1950 Endpoint for a Data Router client that implements a Subscriber
1963 return DR_Sub details
1970 Create a `DR_Sub` object.
1986 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
1990 .. code-block:: javascript
1997 "dcaeLocationName": "somestring",
1998 "deliveryURL": "somestring",
1999 "feedId": "somestring",
2000 "lastMod": "2015-01-01T15:00:00.000Z",
2001 "logURL": "somestring",
2002 "owner": "somestring",
2004 "statusValid": true,
2005 "subId": "somestring",
2008 "username": "somestring",
2009 "userpwd": "somestring"
2018 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2022 .. code-block:: javascript
2026 "fields": "somestring",
2028 "message": "somestring"
2035 DELETE ``/dr_subs/{subId}``
2036 ---------------------------
2042 return DR_Sub details
2049 Delete a `DR_Sub` object, selected by subId
2056 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2057 :widths: 20, 15, 10, 10, 10, 20, 30
2059 subId | path | Yes | string | | |
2075 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2079 .. code-block:: javascript
2086 "dcaeLocationName": "somestring",
2087 "deliveryURL": "somestring",
2088 "feedId": "somestring",
2089 "lastMod": "2015-01-01T15:00:00.000Z",
2090 "logURL": "somestring",
2091 "owner": "somestring",
2093 "statusValid": true,
2094 "subId": "somestring",
2097 "username": "somestring",
2098 "userpwd": "somestring"
2107 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2111 .. code-block:: javascript
2115 "fields": "somestring",
2117 "message": "somestring"
2124 GET ``/dr_subs/{subId}``
2125 ------------------------
2131 return DR_Sub details
2138 Retrieve a `DR_Sub` object, selected by subId
2145 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2146 :widths: 20, 15, 10, 10, 10, 20, 30
2148 subId | path | Yes | string | | |
2164 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2168 .. code-block:: javascript
2175 "dcaeLocationName": "somestring",
2176 "deliveryURL": "somestring",
2177 "feedId": "somestring",
2178 "lastMod": "2015-01-01T15:00:00.000Z",
2179 "logURL": "somestring",
2180 "owner": "somestring",
2182 "statusValid": true,
2183 "subId": "somestring",
2186 "username": "somestring",
2187 "userpwd": "somestring"
2196 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2200 .. code-block:: javascript
2204 "fields": "somestring",
2206 "message": "somestring"
2220 return DR_Sub details
2227 Returns array of `DR_Sub` objects. Add filter for feedId.
2243 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2247 .. code-block:: javascript
2254 "dcaeLocationName": "somestring",
2255 "deliveryURL": "somestring",
2256 "feedId": "somestring",
2257 "lastMod": "2015-01-01T15:00:00.000Z",
2258 "logURL": "somestring",
2259 "owner": "somestring",
2261 "statusValid": true,
2262 "subId": "somestring",
2265 "username": "somestring",
2266 "userpwd": "somestring"
2275 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2279 .. code-block:: javascript
2283 "fields": "somestring",
2285 "message": "somestring"
2292 PUT ``/dr_subs/{subId}``
2293 ------------------------
2299 return DR_Sub details
2306 Update a `DR_Sub` object, selected by subId
2313 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2314 :widths: 20, 15, 10, 10, 10, 20, 30
2316 subId | path | Yes | string | | |
2332 Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
2336 .. code-block:: javascript
2343 "dcaeLocationName": "somestring",
2344 "deliveryURL": "somestring",
2345 "feedId": "somestring",
2346 "lastMod": "2015-01-01T15:00:00.000Z",
2347 "logURL": "somestring",
2348 "owner": "somestring",
2350 "statusValid": true,
2351 "subId": "somestring",
2354 "username": "somestring",
2355 "userpwd": "somestring"
2364 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2368 .. code-block:: javascript
2372 "fields": "somestring",
2374 "message": "somestring"
2384 Endpoint for a Data Router Feed
2404 Create a of `Feed` object.
2411 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2412 :widths: 20, 15, 10, 10, 10, 20, 30
2414 useExisting | query | No | string | | |
2430 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2434 .. code-block:: javascript
2437 "dcaeLocationName": "somestring",
2438 "feedId": "somestring",
2439 "lastMod": "2015-01-01T15:00:00.000Z",
2440 "pubId": "somestring",
2442 "statusValid": true,
2443 "username": "somestring",
2444 "userpwd": "somestring"
2453 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2457 .. code-block:: javascript
2461 "fields": "somestring",
2463 "message": "somestring"
2470 DELETE ``/feeds/{id}``
2471 ----------------------
2484 Delete a `Feed` object, specified by id.
2491 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2492 :widths: 20, 15, 10, 10, 10, 20, 30
2494 id | path | Yes | string | | |
2507 successful operation
2510 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2514 .. code-block:: javascript
2517 "asprClassification": "somestring",
2522 "feedDescription": "somestring",
2523 "feedId": "somestring",
2524 "feedName": "somestring",
2525 "feedVersion": "somestring",
2526 "formatUuid": "somestring",
2527 "lastMod": "2015-01-01T15:00:00.000Z",
2528 "logURL": "somestring",
2529 "owner": "somestring",
2530 "publishURL": "somestring",
2533 "dcaeLocationName": "somestring",
2534 "feedId": "somestring",
2535 "lastMod": "2015-01-01T15:00:00.000Z",
2536 "pubId": "somestring",
2538 "statusValid": true,
2539 "username": "somestring",
2540 "userpwd": "somestring"
2543 "dcaeLocationName": "somestring",
2544 "feedId": "somestring",
2545 "lastMod": "2015-01-01T15:00:00.000Z",
2546 "pubId": "somestring",
2548 "statusValid": true,
2549 "username": "somestring",
2550 "userpwd": "somestring"
2554 "statusValid": true,
2561 "dcaeLocationName": "somestring",
2562 "deliveryURL": "somestring",
2563 "feedId": "somestring",
2564 "lastMod": "2015-01-01T15:00:00.000Z",
2565 "logURL": "somestring",
2566 "owner": "somestring",
2568 "statusValid": true,
2569 "subId": "somestring",
2572 "username": "somestring",
2573 "userpwd": "somestring"
2580 "dcaeLocationName": "somestring",
2581 "deliveryURL": "somestring",
2582 "feedId": "somestring",
2583 "lastMod": "2015-01-01T15:00:00.000Z",
2584 "logURL": "somestring",
2585 "owner": "somestring",
2587 "statusValid": true,
2588 "subId": "somestring",
2591 "username": "somestring",
2592 "userpwd": "somestring"
2595 "subscribeURL": "somestring",
2605 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2609 .. code-block:: javascript
2612 "dcaeLocationName": "somestring",
2613 "feedId": "somestring",
2614 "lastMod": "2015-01-01T15:00:00.000Z",
2615 "pubId": "somestring",
2617 "statusValid": true,
2618 "username": "somestring",
2619 "userpwd": "somestring"
2628 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2632 .. code-block:: javascript
2636 "fields": "somestring",
2638 "message": "somestring"
2659 Retrieve a `Feed` object, specified by id.
2666 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2667 :widths: 20, 15, 10, 10, 10, 20, 30
2669 id | path | Yes | string | | |
2685 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2689 .. code-block:: javascript
2692 "dcaeLocationName": "somestring",
2693 "feedId": "somestring",
2694 "lastMod": "2015-01-01T15:00:00.000Z",
2695 "pubId": "somestring",
2697 "statusValid": true,
2698 "username": "somestring",
2699 "userpwd": "somestring"
2708 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2712 .. code-block:: javascript
2716 "fields": "somestring",
2718 "message": "somestring"
2739 Returns array of `Feed` objects.
2746 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2747 :widths: 20, 15, 10, 10, 10, 20, 30
2749 feedName | query | No | string | | |
2750 version | query | No | string | | |
2751 match | query | No | string | | |
2767 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2771 .. code-block:: javascript
2774 "dcaeLocationName": "somestring",
2775 "feedId": "somestring",
2776 "lastMod": "2015-01-01T15:00:00.000Z",
2777 "pubId": "somestring",
2779 "statusValid": true,
2780 "username": "somestring",
2781 "userpwd": "somestring"
2790 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2794 .. code-block:: javascript
2798 "fields": "somestring",
2800 "message": "somestring"
2821 Update a `Feed` object, specified by id.
2828 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2829 :widths: 20, 15, 10, 10, 10, 20, 30
2831 id | path | Yes | string | | |
2847 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2851 .. code-block:: javascript
2854 "dcaeLocationName": "somestring",
2855 "feedId": "somestring",
2856 "lastMod": "2015-01-01T15:00:00.000Z",
2857 "pubId": "somestring",
2859 "statusValid": true,
2860 "username": "somestring",
2861 "userpwd": "somestring"
2870 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2874 .. code-block:: javascript
2878 "fields": "somestring",
2880 "message": "somestring"
2890 Endpoint for this instance of DBCL. Returns health info.
2910 returns the `info` object
2926 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
2930 .. code-block:: javascript
2933 "accessKeyOwner": "somestring",
2934 "bridgeAdminTopic": "somestring",
2935 "dmaapName": "somestring",
2936 "drProvUrl": "somestring",
2937 "lastMod": "2015-01-01T15:00:00.000Z",
2938 "loggingUrl": "somestring",
2939 "nodeKey": "somestring",
2941 "statusValid": true,
2942 "topicNsRoot": "somestring",
2943 "version": "somestring"
2952 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2956 .. code-block:: javascript
2960 "fields": "somestring",
2962 "message": "somestring"
2972 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
2978 POST ``/mr_clients``
2979 --------------------
2985 return MR_Client details
2992 Create a `MR_Client` object.
3008 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3012 .. code-block:: javascript
3015 "dcaeLocationName": "somestring",
3016 "feedId": "somestring",
3017 "lastMod": "2015-01-01T15:00:00.000Z",
3018 "pubId": "somestring",
3020 "statusValid": true,
3021 "username": "somestring",
3022 "userpwd": "somestring"
3031 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3035 .. code-block:: javascript
3039 "fields": "somestring",
3041 "message": "somestring"
3048 DELETE ``/mr_clients/{subId}``
3049 ------------------------------
3055 return MR_Client details
3062 Delete a `MR_Client` object, specified by clientId
3069 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3070 :widths: 20, 15, 10, 10, 10, 20, 30
3072 subId | path | Yes | string | | |
3085 successful operation
3088 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
3092 .. code-block:: javascript
3099 "clientRole": "somestring",
3100 "dcaeLocationName": "somestring",
3101 "fqtn": "somestring",
3102 "lastMod": "2015-01-01T15:00:00.000Z",
3103 "mrClientId": "somestring",
3105 "statusValid": true,
3106 "topicURL": "somestring"
3115 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3119 .. code-block:: javascript
3122 "dcaeLocationName": "somestring",
3123 "feedId": "somestring",
3124 "lastMod": "2015-01-01T15:00:00.000Z",
3125 "pubId": "somestring",
3127 "statusValid": true,
3128 "username": "somestring",
3129 "userpwd": "somestring"
3138 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3142 .. code-block:: javascript
3146 "fields": "somestring",
3148 "message": "somestring"
3162 return MR_Client details
3169 Returns array of `MR_Client` objects.
3185 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3189 .. code-block:: javascript
3192 "dcaeLocationName": "somestring",
3193 "feedId": "somestring",
3194 "lastMod": "2015-01-01T15:00:00.000Z",
3195 "pubId": "somestring",
3197 "statusValid": true,
3198 "username": "somestring",
3199 "userpwd": "somestring"
3208 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3212 .. code-block:: javascript
3216 "fields": "somestring",
3218 "message": "somestring"
3225 GET ``/mr_clients/{subId}``
3226 ---------------------------
3232 return MR_Client details
3239 Retrieve a `MR_Client` object, specified by clientId
3246 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3247 :widths: 20, 15, 10, 10, 10, 20, 30
3249 subId | path | Yes | string | | |
3265 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3269 .. code-block:: javascript
3272 "dcaeLocationName": "somestring",
3273 "feedId": "somestring",
3274 "lastMod": "2015-01-01T15:00:00.000Z",
3275 "pubId": "somestring",
3277 "statusValid": true,
3278 "username": "somestring",
3279 "userpwd": "somestring"
3288 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3292 .. code-block:: javascript
3296 "fields": "somestring",
3298 "message": "somestring"
3305 PUT ``/mr_clients/{clientId}``
3306 ------------------------------
3312 return MR_Client details
3319 Update a `MR_Client` object, specified by clientId
3326 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3327 :widths: 20, 15, 10, 10, 10, 20, 30
3329 clientId | path | Yes | string | | |
3345 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3349 .. code-block:: javascript
3352 "dcaeLocationName": "somestring",
3353 "feedId": "somestring",
3354 "lastMod": "2015-01-01T15:00:00.000Z",
3355 "pubId": "somestring",
3357 "statusValid": true,
3358 "username": "somestring",
3359 "userpwd": "somestring"
3368 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3372 .. code-block:: javascript
3376 "fields": "somestring",
3378 "message": "somestring"
3388 Endpoint for a Message Router servers in a Cluster configuration
3394 POST ``/mr_clusters``
3395 ---------------------
3401 return MR_Cluster details
3408 Create an `MR_Cluster` object.
3424 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3428 .. code-block:: javascript
3431 "dcaeLocationName": "somestring",
3432 "feedId": "somestring",
3433 "lastMod": "2015-01-01T15:00:00.000Z",
3434 "pubId": "somestring",
3436 "statusValid": true,
3437 "username": "somestring",
3438 "userpwd": "somestring"
3447 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3451 .. code-block:: javascript
3455 "fields": "somestring",
3457 "message": "somestring"
3464 DELETE ``/mr_clusters/{clusterId}``
3465 -----------------------------------
3471 return MR_Cluster details
3478 Delete an `MR_Cluster` object, specified by clusterId.
3485 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3486 :widths: 20, 15, 10, 10, 10, 20, 30
3488 clusterId | path | Yes | string | | |
3501 successful operation
3504 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3508 .. code-block:: javascript
3511 "dcaeLocationName": "somestring",
3512 "fqdn": "somestring",
3513 "lastMod": "2015-01-01T15:00:00.000Z",
3514 "replicationGroup": "somestring",
3515 "sourceReplicationPort": "somestring",
3517 "statusValid": true,
3518 "targetReplicationPort": "somestring",
3519 "topicPort": "somestring",
3520 "topicProtocol": "somestring"
3529 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3533 .. code-block:: javascript
3536 "dcaeLocationName": "somestring",
3537 "feedId": "somestring",
3538 "lastMod": "2015-01-01T15:00:00.000Z",
3539 "pubId": "somestring",
3541 "statusValid": true,
3542 "username": "somestring",
3543 "userpwd": "somestring"
3552 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3556 .. code-block:: javascript
3560 "fields": "somestring",
3562 "message": "somestring"
3569 GET ``/mr_clusters/{clusterId}``
3570 --------------------------------
3576 return MR_Cluster details
3583 Retrieve an `MR_Cluster` object, specified by clusterId.
3590 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3591 :widths: 20, 15, 10, 10, 10, 20, 30
3593 clusterId | path | Yes | string | | |
3609 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3613 .. code-block:: javascript
3616 "dcaeLocationName": "somestring",
3617 "feedId": "somestring",
3618 "lastMod": "2015-01-01T15:00:00.000Z",
3619 "pubId": "somestring",
3621 "statusValid": true,
3622 "username": "somestring",
3623 "userpwd": "somestring"
3632 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3636 .. code-block:: javascript
3640 "fields": "somestring",
3642 "message": "somestring"
3649 GET ``/mr_clusters``
3650 --------------------
3656 return MR_Cluster details
3663 Returns array of `MR_Cluster` objects.
3679 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3683 .. code-block:: javascript
3686 "dcaeLocationName": "somestring",
3687 "feedId": "somestring",
3688 "lastMod": "2015-01-01T15:00:00.000Z",
3689 "pubId": "somestring",
3691 "statusValid": true,
3692 "username": "somestring",
3693 "userpwd": "somestring"
3702 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3706 .. code-block:: javascript
3710 "fields": "somestring",
3712 "message": "somestring"
3719 PUT ``/mr_clusters/{clusterId}``
3720 --------------------------------
3726 return MR_Cluster details
3733 Update an `MR_Cluster` object, specified by clusterId.
3740 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3741 :widths: 20, 15, 10, 10, 10, 20, 30
3743 clusterId | path | Yes | string | | |
3759 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3763 .. code-block:: javascript
3766 "dcaeLocationName": "somestring",
3767 "feedId": "somestring",
3768 "lastMod": "2015-01-01T15:00:00.000Z",
3769 "pubId": "somestring",
3771 "statusValid": true,
3772 "username": "somestring",
3773 "userpwd": "somestring"
3782 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3786 .. code-block:: javascript
3790 "fields": "somestring",
3792 "message": "somestring"
3802 Endpoint for retreiving MR Topics
3815 return Topic details
3822 Create `Topic` object.
3829 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3830 :widths: 20, 15, 10, 10, 10, 20, 30
3832 useExisting | query | No | string | | |
3848 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3852 .. code-block:: javascript
3855 "dcaeLocationName": "somestring",
3856 "feedId": "somestring",
3857 "lastMod": "2015-01-01T15:00:00.000Z",
3858 "pubId": "somestring",
3860 "statusValid": true,
3861 "username": "somestring",
3862 "userpwd": "somestring"
3871 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3875 .. code-block:: javascript
3879 "fields": "somestring",
3881 "message": "somestring"
3888 DELETE ``/topics/{topicId}``
3889 ----------------------------
3895 return Topic details
3902 Delete a `Topic` object, identified by topicId
3909 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3910 :widths: 20, 15, 10, 10, 10, 20, 30
3912 topicId | path | Yes | string | | |
3925 successful operation
3928 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
3932 .. code-block:: javascript
3945 "clientRole": "somestring",
3946 "dcaeLocationName": "somestring",
3947 "fqtn": "somestring",
3948 "lastMod": "2015-01-01T15:00:00.000Z",
3949 "mrClientId": "somestring",
3951 "statusValid": true,
3952 "topicURL": "somestring"
3959 "clientRole": "somestring",
3960 "dcaeLocationName": "somestring",
3961 "fqtn": "somestring",
3962 "lastMod": "2015-01-01T15:00:00.000Z",
3963 "mrClientId": "somestring",
3965 "statusValid": true,
3966 "topicURL": "somestring"
3969 "formatUuid": "somestring",
3970 "fqtn": "somestring",
3971 "fqtnStyle": "FQTN_NOT_SPECIFIED",
3972 "globalMrURL": "somestring",
3973 "lastMod": "2015-01-01T15:00:00.000Z",
3975 "owner": "somestring",
3976 "partitionCount": "somestring",
3977 "replicationCase": "REPLICATION_NOT_SPECIFIED",
3978 "replicationCount": "somestring",
3980 "statusValid": true,
3981 "tnxEnabled": "somestring",
3982 "topicDescription": "somestring",
3983 "topicName": "somestring",
3984 "version": "somestring"
3993 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3997 .. code-block:: javascript
4000 "dcaeLocationName": "somestring",
4001 "feedId": "somestring",
4002 "lastMod": "2015-01-01T15:00:00.000Z",
4003 "pubId": "somestring",
4005 "statusValid": true,
4006 "username": "somestring",
4007 "userpwd": "somestring"
4016 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4020 .. code-block:: javascript
4024 "fields": "somestring",
4026 "message": "somestring"
4033 GET ``/topics/{topicId}``
4034 -------------------------
4040 return Topic details
4047 Retrieve a `Topic` object, identified by topicId
4054 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4055 :widths: 20, 15, 10, 10, 10, 20, 30
4057 topicId | path | Yes | string | | |
4073 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
4077 .. code-block:: javascript
4080 "dcaeLocationName": "somestring",
4081 "feedId": "somestring",
4082 "lastMod": "2015-01-01T15:00:00.000Z",
4083 "pubId": "somestring",
4085 "statusValid": true,
4086 "username": "somestring",
4087 "userpwd": "somestring"
4096 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4100 .. code-block:: javascript
4104 "fields": "somestring",
4106 "message": "somestring"
4120 return Topic details
4127 Returns array of `Topic` objects.
4143 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
4147 .. code-block:: javascript
4150 "dcaeLocationName": "somestring",
4151 "feedId": "somestring",
4152 "lastMod": "2015-01-01T15:00:00.000Z",
4153 "pubId": "somestring",
4155 "statusValid": true,
4156 "username": "somestring",
4157 "userpwd": "somestring"
4166 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4170 .. code-block:: javascript
4174 "fields": "somestring",
4176 "message": "somestring"
4183 PUT ``/topics/{topicId}``
4184 -------------------------
4190 return Topic details
4197 Update a `Topic` object, identified by topicId
4204 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
4205 :widths: 20, 15, 10, 10, 10, 20, 30
4207 topicId | path | Yes | string | | |
4223 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
4227 .. code-block:: javascript
4230 "dcaeLocationName": "somestring",
4231 "feedId": "somestring",
4232 "lastMod": "2015-01-01T15:00:00.000Z",
4233 "pubId": "somestring",
4235 "statusValid": true,
4236 "username": "somestring",
4237 "userpwd": "somestring"
4246 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
4250 .. code-block:: javascript
4254 "fields": "somestring",
4256 "message": "somestring"
4265 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
4267 ApiError Model Structure
4268 ------------------------
4272 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4273 :widths: 20, 10, 15, 15, 30, 25
4275 code | No | integer | int32 | |
4276 fields | No | string | | |
4277 is2xx | No | boolean | | |
4278 message | No | string | | |
4280 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
4282 BrTopic Model Structure
4283 -----------------------
4287 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4288 :widths: 20, 10, 15, 15, 30, 25
4290 brSource | No | string | | |
4291 brTarget | No | string | | |
4292 mmAgentName | No | string | | |
4293 topicCount | No | integer | int32 | |
4295 .. _d_d15e2cee407536866c875375e3f705e0:
4297 DR_Node Model Structure
4298 -----------------------
4302 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4303 :widths: 20, 10, 15, 15, 30, 25
4305 dcaeLocationName | No | string | | |
4306 fqdn | No | string | | |
4307 hostName | No | string | | |
4308 lastMod | No | string | date-time | |
4309 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4310 statusValid | No | boolean | | |
4311 version | No | string | | |
4313 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4315 DR_Pub Model Structure
4316 ----------------------
4320 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4321 :widths: 20, 10, 15, 15, 30, 25
4323 dcaeLocationName | No | string | | |
4324 feedId | No | string | | |
4325 lastMod | No | string | date-time | |
4326 pubId | No | string | | |
4327 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4328 statusValid | No | boolean | | |
4329 username | No | string | | |
4330 userpwd | No | string | | |
4332 .. _d_48cf328d246f41e1d11a09251b042f02:
4334 DR_Sub Model Structure
4335 ----------------------
4339 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4340 :widths: 20, 10, 15, 15, 30, 25
4342 bytes | No | array of string | | |
4343 dcaeLocationName | No | string | | |
4344 deliveryURL | No | string | | |
4345 feedId | No | string | | |
4346 lastMod | No | string | date-time | |
4347 logURL | No | string | | |
4348 owner | No | string | | |
4349 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4350 statusValid | No | boolean | | |
4351 subId | No | string | | |
4352 suspended | No | boolean | | |
4353 use100 | No | boolean | | |
4354 username | No | string | | |
4355 userpwd | No | string | | |
4357 .. _d_47d80e451933beb623fcf5257867cbcb:
4359 DcaeLocation Model Structure
4360 ----------------------------
4364 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4365 :widths: 20, 10, 15, 15, 30, 25
4367 central | No | boolean | | |
4368 clli | No | string | | |
4369 dcaeLayer | No | string | | |
4370 dcaeLocationName | No | string | | |
4371 lastMod | No | string | date-time | |
4372 local | No | boolean | | |
4373 openStackAvailabilityZone | No | string | | |
4374 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4375 statusValid | No | boolean | | |
4376 subnet | No | string | | |
4378 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4380 Dmaap Model Structure
4381 ---------------------
4385 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4386 :widths: 20, 10, 15, 15, 30, 25
4388 accessKeyOwner | No | string | | |
4389 bridgeAdminTopic | No | string | | |
4390 dmaapName | No | string | | |
4391 drProvUrl | No | string | | |
4392 lastMod | No | string | date-time | |
4393 loggingUrl | No | string | | |
4394 nodeKey | No | string | | |
4395 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4396 statusValid | No | boolean | | |
4397 topicNsRoot | No | string | | |
4398 version | No | string | | |
4400 .. _d_289ad39619725df26c9ff382d4c97c75:
4402 Feed Model Structure
4403 --------------------
4407 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4408 :widths: 20, 10, 15, 15, 30, 25
4410 asprClassification | No | string | | |
4411 bytes | No | array of string | | |
4412 feedDescription | No | string | | |
4413 feedId | No | string | | |
4414 feedName | No | string | | |
4415 feedVersion | No | string | | |
4416 formatUuid | No | string | | |
4417 lastMod | No | string | date-time | |
4418 logURL | No | string | | |
4419 owner | No | string | | |
4420 publishURL | No | string | | |
4421 pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
4422 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4423 statusValid | No | boolean | | |
4424 subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
4425 subscribeURL | No | string | | |
4426 suspended | No | boolean | | |
4428 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4430 MR_Client Model Structure
4431 -------------------------
4435 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4436 :widths: 20, 10, 15, 15, 30, 25
4438 action | No | array of string | | |
4439 clientRole | No | string | | |
4440 dcaeLocationName | No | string | | |
4441 fqtn | No | string | | |
4442 lastMod | No | string | date-time | |
4443 mrClientId | No | string | | |
4444 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4445 statusValid | No | boolean | | |
4446 topicURL | No | string | | |
4448 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4450 MR_Cluster Model Structure
4451 --------------------------
4455 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4456 :widths: 20, 10, 15, 15, 30, 25
4458 dcaeLocationName | No | string | | |
4459 fqdn | No | string | | |
4460 lastMod | No | string | date-time | |
4461 replicationGroup | No | string | | |
4462 sourceReplicationPort | No | string | | |
4463 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4464 statusValid | No | boolean | | |
4465 targetReplicationPort | No | string | | |
4466 topicPort | No | string | | |
4467 topicProtocol | No | string | | |
4469 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4471 MirrorMaker Model Structure
4472 ---------------------------
4476 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4477 :widths: 20, 10, 15, 15, 30, 25
4479 lastMod | No | string | date-time | |
4480 mmName | No | string | | |
4481 sourceCluster | No | string | | |
4482 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4483 statusValid | No | boolean | | |
4484 targetCluster | No | string | | |
4485 topicCount | No | integer | int32 | |
4486 topics | No | array of string | | |
4487 whitelistUpdateJSON | No | string | | |
4489 .. _d_2e99841971da81b9d240071b86bf168d:
4491 Topic Model Structure
4492 ---------------------
4496 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4497 :widths: 20, 10, 15, 15, 30, 25
4499 bytes | No | array of string | | |
4500 clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | |
4501 formatUuid | No | string | | |
4502 fqtn | No | string | | |
4503 fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} |
4504 globalMrURL | No | string | | |
4505 lastMod | No | string | date-time | |
4506 numClients | No | integer | int32 | |
4507 owner | No | string | | |
4508 partitionCount | No | string | | |
4509 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']} |
4510 replicationCount | No | string | | |
4511 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4512 statusValid | No | boolean | | |
4513 tnxEnabled | No | string | | |
4514 topicDescription | No | string | | |
4515 topicName | No | string | | |
4516 version | No | string | | |