1 DMaaP Bus Controller REST API 1.1.0
2 ===================================
11 provides an API for OpenDCAE components which need to provision underlying DMaaP technologies (Data Router and Message Router). Primary clients for this API are anticipated to be the OpenDCAE Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the ECOMP Portal.
13 Objects managed by DMaaP are deployed in a dcaeLocation which is a unique identifier for an OpenStack tenant for a dcaeLayer, opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
15 A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A DMaaP is managed by a one or more stateless DMaaP Bus Controller(s), though Bus Controller relies on PGaaS for persistence. Each DMaaP has a single instance of Data Router, which has 1 or more DR_Nodes deployed at each dcaeLocation. DR Clients of type DR_Pub generally publish to a DR_Node that is local to its dcaeLocation. Routing for a Feed is determined by the dcaelocation of its DR_Sub clients.
17 A DMaaP may have many Message Router instances. Each instance is deployed as an MR_Cluster. One MR_Cluster is deployed at each dcaeLocation. MR_Clients generally communicate to the MR_Cluster at the same dcaeLocation. Replication of messages between MR_Clusters is accomplished by MR Bridge, which is provioned by DMaaP Bus Controller based on Topic attributes.
19 Therefore, the role of DMaaP Bus Controller is to support other DCAE infrastructure components to dynamically provision DMaaP services on behalf of DMaaP clients, and to assist in any management or discovery activity of its clients.
21 A convention of this API is to return JSON responses per OpenStack style.
40 `Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
48 http://www.[host]:[port]/webapi
49 https://www.[host]:[port]/webapi
55 Endpoint for retreiving MR Bridge metrics
68 return BrTopic details
75 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
82 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
83 :widths: 20, 15, 10, 10, 10, 20, 30
85 source | query | No | string | | |
86 target | query | No | string | | |
87 detail | query | No | boolean | | |
103 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
107 .. code-block:: javascript
110 "accessKeyOwner": "somestring",
111 "bridgeAdminTopic": "somestring",
112 "dmaapName": "somestring",
113 "drProvUrl": "somestring",
114 "lastMod": "2015-01-01T15:00:00.000Z",
115 "loggingUrl": "somestring",
116 "nodeKey": "somestring",
119 "topicNsRoot": "somestring",
120 "version": "somestring"
129 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
133 .. code-block:: javascript
137 "fields": "somestring",
139 "message": "somestring"
153 update MirrorMaker details
160 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
167 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
168 :widths: 20, 15, 10, 10, 10, 20, 30
170 source | query | No | string | | |
171 target | query | No | string | | |
172 refresh | query | No | boolean | | |
188 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
192 .. code-block:: javascript
195 "accessKeyOwner": "somestring",
196 "bridgeAdminTopic": "somestring",
197 "dmaapName": "somestring",
198 "drProvUrl": "somestring",
199 "lastMod": "2015-01-01T15:00:00.000Z",
200 "loggingUrl": "somestring",
201 "nodeKey": "somestring",
204 "topicNsRoot": "somestring",
205 "version": "somestring"
214 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
218 .. code-block:: javascript
222 "fields": "somestring",
224 "message": "somestring"
234 an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
240 POST ``/dcaeLocations``
241 -----------------------
247 return dcaeLocation details
254 Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
270 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
274 .. code-block:: javascript
277 "accessKeyOwner": "somestring",
278 "bridgeAdminTopic": "somestring",
279 "dmaapName": "somestring",
280 "drProvUrl": "somestring",
281 "lastMod": "2015-01-01T15:00:00.000Z",
282 "loggingUrl": "somestring",
283 "nodeKey": "somestring",
286 "topicNsRoot": "somestring",
287 "version": "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:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
357 .. code-block:: javascript
360 "accessKeyOwner": "somestring",
361 "bridgeAdminTopic": "somestring",
362 "dmaapName": "somestring",
363 "drProvUrl": "somestring",
364 "lastMod": "2015-01-01T15:00:00.000Z",
365 "loggingUrl": "somestring",
366 "nodeKey": "somestring",
369 "topicNsRoot": "somestring",
370 "version": "somestring"
379 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
383 .. code-block:: javascript
386 "accessKeyOwner": "somestring",
387 "bridgeAdminTopic": "somestring",
388 "dmaapName": "somestring",
389 "drProvUrl": "somestring",
390 "lastMod": "2015-01-01T15:00:00.000Z",
391 "loggingUrl": "somestring",
392 "nodeKey": "somestring",
395 "topicNsRoot": "somestring",
396 "version": "somestring"
405 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
409 .. code-block:: javascript
413 "fields": "somestring",
415 "message": "somestring"
422 GET ``/dcaeLocations/{locationName}``
423 -------------------------------------
429 return dcaeLocation details
436 Returns a specific `dcaeLocation` object with specified tag
443 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
444 :widths: 20, 15, 10, 10, 10, 20, 30
446 locationName | path | Yes | string | | |
462 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
466 .. code-block:: javascript
469 "accessKeyOwner": "somestring",
470 "bridgeAdminTopic": "somestring",
471 "dmaapName": "somestring",
472 "drProvUrl": "somestring",
473 "lastMod": "2015-01-01T15:00:00.000Z",
474 "loggingUrl": "somestring",
475 "nodeKey": "somestring",
478 "topicNsRoot": "somestring",
479 "version": "somestring"
488 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
492 .. code-block:: javascript
496 "fields": "somestring",
498 "message": "somestring"
505 GET ``/dcaeLocations``
506 ----------------------
512 return dcaeLocation details
519 Returns array of `dcaeLocation` objects. All objects managed by DMaaP are deployed in some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
535 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
539 .. code-block:: javascript
542 "accessKeyOwner": "somestring",
543 "bridgeAdminTopic": "somestring",
544 "dmaapName": "somestring",
545 "drProvUrl": "somestring",
546 "lastMod": "2015-01-01T15:00:00.000Z",
547 "loggingUrl": "somestring",
548 "nodeKey": "somestring",
551 "topicNsRoot": "somestring",
552 "version": "somestring"
561 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
565 .. code-block:: javascript
569 "fields": "somestring",
571 "message": "somestring"
578 PUT ``/dcaeLocations/{locationName}``
579 -------------------------------------
585 return dcaeLocation details
592 update the openStackAvailabilityZone of a dcaeLocation
599 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
600 :widths: 20, 15, 10, 10, 10, 20, 30
602 locationName | path | Yes | string | | |
618 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
622 .. code-block:: javascript
625 "accessKeyOwner": "somestring",
626 "bridgeAdminTopic": "somestring",
627 "dmaapName": "somestring",
628 "drProvUrl": "somestring",
629 "lastMod": "2015-01-01T15:00:00.000Z",
630 "loggingUrl": "somestring",
631 "nodeKey": "somestring",
634 "topicNsRoot": "somestring",
635 "version": "somestring"
644 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
648 .. code-block:: javascript
652 "fields": "somestring",
654 "message": "somestring"
664 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
684 Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
700 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
704 .. code-block:: javascript
707 "accessKeyOwner": "somestring",
708 "bridgeAdminTopic": "somestring",
709 "dmaapName": "somestring",
710 "drProvUrl": "somestring",
711 "lastMod": "2015-01-01T15:00:00.000Z",
712 "loggingUrl": "somestring",
713 "nodeKey": "somestring",
716 "topicNsRoot": "somestring",
717 "version": "somestring"
726 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
730 .. code-block:: javascript
734 "fields": "somestring",
736 "message": "somestring"
757 returns the `dmaap` object, which contains system wide configuration settings
773 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
777 .. code-block:: javascript
780 "accessKeyOwner": "somestring",
781 "bridgeAdminTopic": "somestring",
782 "dmaapName": "somestring",
783 "drProvUrl": "somestring",
784 "lastMod": "2015-01-01T15:00:00.000Z",
785 "loggingUrl": "somestring",
786 "nodeKey": "somestring",
789 "topicNsRoot": "somestring",
790 "version": "somestring"
799 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
803 .. code-block:: javascript
807 "fields": "somestring",
809 "message": "somestring"
830 Update system settings for *dcaeEnvironment*.
846 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
850 .. code-block:: javascript
853 "accessKeyOwner": "somestring",
854 "bridgeAdminTopic": "somestring",
855 "dmaapName": "somestring",
856 "drProvUrl": "somestring",
857 "lastMod": "2015-01-01T15:00:00.000Z",
858 "loggingUrl": "somestring",
859 "nodeKey": "somestring",
862 "topicNsRoot": "somestring",
863 "version": "somestring"
872 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
876 .. code-block:: javascript
880 "fields": "somestring",
882 "message": "somestring"
892 Endpoint for a Data Router Node server
905 return DR_Node details
912 create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
928 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
932 .. code-block:: javascript
935 "dcaeLocationName": "somestring",
936 "fqdn": "somestring",
937 "hostName": "somestring",
938 "lastMod": "2015-01-01T15:00:00.000Z",
941 "version": "somestring"
950 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
954 .. code-block:: javascript
958 "fields": "somestring",
960 "message": "somestring"
967 DELETE ``/dr_nodes/{fqdn}``
968 ---------------------------
981 Delete a single `DR_Node` object.
988 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
989 :widths: 20, 15, 10, 10, 10, 20, 30
991 fqdn | path | Yes | string | | |
1004 successful operation
1007 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1011 .. code-block:: javascript
1014 "dcaeLocationName": "somestring",
1015 "fqdn": "somestring",
1016 "hostName": "somestring",
1017 "lastMod": "2015-01-01T15:00:00.000Z",
1019 "statusValid": true,
1020 "version": "somestring"
1029 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1033 .. code-block:: javascript
1036 "dcaeLocationName": "somestring",
1037 "fqdn": "somestring",
1038 "hostName": "somestring",
1039 "lastMod": "2015-01-01T15:00:00.000Z",
1041 "statusValid": true,
1042 "version": "somestring"
1051 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1055 .. code-block:: javascript
1059 "fields": "somestring",
1061 "message": "somestring"
1068 GET ``/dr_nodes/{fqdn}``
1069 ------------------------
1075 return DR_Node details
1082 Retrieve a single `DR_Node` object.
1089 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1090 :widths: 20, 15, 10, 10, 10, 20, 30
1092 fqdn | path | Yes | string | | |
1108 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1112 .. code-block:: javascript
1115 "dcaeLocationName": "somestring",
1116 "fqdn": "somestring",
1117 "hostName": "somestring",
1118 "lastMod": "2015-01-01T15:00:00.000Z",
1120 "statusValid": true,
1121 "version": "somestring"
1130 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1134 .. code-block:: javascript
1138 "fields": "somestring",
1140 "message": "somestring"
1154 return DR_Node details
1161 Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
1177 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1181 .. code-block:: javascript
1184 "dcaeLocationName": "somestring",
1185 "fqdn": "somestring",
1186 "hostName": "somestring",
1187 "lastMod": "2015-01-01T15:00:00.000Z",
1189 "statusValid": true,
1190 "version": "somestring"
1199 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1203 .. code-block:: javascript
1207 "fields": "somestring",
1209 "message": "somestring"
1216 PUT ``/dr_nodes/{fqdn}``
1217 ------------------------
1223 return DR_Node details
1230 Update a single `DR_Node` object.
1237 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1238 :widths: 20, 15, 10, 10, 10, 20, 30
1240 fqdn | path | Yes | string | | |
1256 Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
1260 .. code-block:: javascript
1263 "dcaeLocationName": "somestring",
1264 "fqdn": "somestring",
1265 "hostName": "somestring",
1266 "lastMod": "2015-01-01T15:00:00.000Z",
1268 "statusValid": true,
1269 "version": "somestring"
1278 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1282 .. code-block:: javascript
1286 "fields": "somestring",
1288 "message": "somestring"
1298 Endpoint for a Data Router client that implements a Publisher
1311 return DR_Pub details
1318 create a DR Publisher in the specified environment.
1334 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1338 .. code-block:: javascript
1341 "dcaeLocationName": "somestring",
1342 "feedId": "somestring",
1343 "lastMod": "2015-01-01T15:00:00.000Z",
1344 "pubId": "somestring",
1346 "statusValid": true,
1347 "username": "somestring",
1348 "userpwd": "somestring"
1357 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1361 .. code-block:: javascript
1365 "fields": "somestring",
1367 "message": "somestring"
1374 DELETE ``/dr_pubs/{pubId}``
1375 ---------------------------
1381 return DR_Pub details
1388 delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
1395 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1396 :widths: 20, 15, 10, 10, 10, 20, 30
1398 pubId | path | Yes | string | | |
1411 successful operation
1414 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1418 .. code-block:: javascript
1421 "dcaeLocationName": "somestring",
1422 "feedId": "somestring",
1423 "lastMod": "2015-01-01T15:00:00.000Z",
1424 "pubId": "somestring",
1426 "statusValid": true,
1427 "username": "somestring",
1428 "userpwd": "somestring"
1437 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1441 .. code-block:: javascript
1444 "dcaeLocationName": "somestring",
1445 "feedId": "somestring",
1446 "lastMod": "2015-01-01T15:00:00.000Z",
1447 "pubId": "somestring",
1449 "statusValid": true,
1450 "username": "somestring",
1451 "userpwd": "somestring"
1460 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1464 .. code-block:: javascript
1468 "fields": "somestring",
1470 "message": "somestring"
1477 GET ``/dr_pubs/{pubId}``
1478 ------------------------
1484 return DR_Pub details
1491 returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
1498 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1499 :widths: 20, 15, 10, 10, 10, 20, 30
1501 pubId | path | Yes | string | | |
1517 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1521 .. code-block:: javascript
1524 "dcaeLocationName": "somestring",
1525 "feedId": "somestring",
1526 "lastMod": "2015-01-01T15:00:00.000Z",
1527 "pubId": "somestring",
1529 "statusValid": true,
1530 "username": "somestring",
1531 "userpwd": "somestring"
1540 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1544 .. code-block:: javascript
1548 "fields": "somestring",
1550 "message": "somestring"
1564 return DR_Pub details
1571 Returns array of `DR_Pub` objects. Add filter for feedId.
1587 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1591 .. code-block:: javascript
1594 "dcaeLocationName": "somestring",
1595 "feedId": "somestring",
1596 "lastMod": "2015-01-01T15:00:00.000Z",
1597 "pubId": "somestring",
1599 "statusValid": true,
1600 "username": "somestring",
1601 "userpwd": "somestring"
1610 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1614 .. code-block:: javascript
1618 "fields": "somestring",
1620 "message": "somestring"
1627 PUT ``/dr_pubs/{pubId}``
1628 ------------------------
1634 return DR_Pub details
1641 update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
1648 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1649 :widths: 20, 15, 10, 10, 10, 20, 30
1651 pubId | path | Yes | string | | |
1667 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1671 .. code-block:: javascript
1674 "dcaeLocationName": "somestring",
1675 "feedId": "somestring",
1676 "lastMod": "2015-01-01T15:00:00.000Z",
1677 "pubId": "somestring",
1679 "statusValid": true,
1680 "username": "somestring",
1681 "userpwd": "somestring"
1690 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1694 .. code-block:: javascript
1698 "fields": "somestring",
1700 "message": "somestring"
1710 Endpoint for a Data Router client that implements a Subscriber
1723 return DR_Sub details
1730 Create a `DR_Sub` object.
1746 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1750 .. code-block:: javascript
1753 "dcaeLocationName": "somestring",
1754 "feedId": "somestring",
1755 "lastMod": "2015-01-01T15:00:00.000Z",
1756 "pubId": "somestring",
1758 "statusValid": true,
1759 "username": "somestring",
1760 "userpwd": "somestring"
1769 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1773 .. code-block:: javascript
1777 "fields": "somestring",
1779 "message": "somestring"
1786 DELETE ``/dr_subs/{subId}``
1787 ---------------------------
1793 return DR_Sub details
1800 Delete a `DR_Sub` object, selected by subId
1807 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1808 :widths: 20, 15, 10, 10, 10, 20, 30
1810 subId | path | Yes | string | | |
1826 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1830 .. code-block:: javascript
1833 "dcaeLocationName": "somestring",
1834 "feedId": "somestring",
1835 "lastMod": "2015-01-01T15:00:00.000Z",
1836 "pubId": "somestring",
1838 "statusValid": true,
1839 "username": "somestring",
1840 "userpwd": "somestring"
1849 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1853 .. code-block:: javascript
1857 "fields": "somestring",
1859 "message": "somestring"
1866 GET ``/dr_subs/{subId}``
1867 ------------------------
1873 return DR_Sub details
1880 Retrieve a `DR_Sub` object, selected by subId
1887 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1888 :widths: 20, 15, 10, 10, 10, 20, 30
1890 subId | path | Yes | string | | |
1906 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1910 .. code-block:: javascript
1913 "dcaeLocationName": "somestring",
1914 "feedId": "somestring",
1915 "lastMod": "2015-01-01T15:00:00.000Z",
1916 "pubId": "somestring",
1918 "statusValid": true,
1919 "username": "somestring",
1920 "userpwd": "somestring"
1929 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
1933 .. code-block:: javascript
1937 "fields": "somestring",
1939 "message": "somestring"
1953 return DR_Sub details
1960 Returns array of `DR_Sub` objects. Add filter for feedId.
1976 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
1980 .. code-block:: javascript
1983 "dcaeLocationName": "somestring",
1984 "feedId": "somestring",
1985 "lastMod": "2015-01-01T15:00:00.000Z",
1986 "pubId": "somestring",
1988 "statusValid": true,
1989 "username": "somestring",
1990 "userpwd": "somestring"
1999 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2003 .. code-block:: javascript
2007 "fields": "somestring",
2009 "message": "somestring"
2016 PUT ``/dr_subs/{subId}``
2017 ------------------------
2023 return DR_Sub details
2030 Update a `DR_Sub` object, selected by subId
2037 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2038 :widths: 20, 15, 10, 10, 10, 20, 30
2040 subId | path | Yes | string | | |
2056 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2060 .. code-block:: javascript
2063 "dcaeLocationName": "somestring",
2064 "feedId": "somestring",
2065 "lastMod": "2015-01-01T15:00:00.000Z",
2066 "pubId": "somestring",
2068 "statusValid": true,
2069 "username": "somestring",
2070 "userpwd": "somestring"
2079 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2083 .. code-block:: javascript
2087 "fields": "somestring",
2089 "message": "somestring"
2099 Endpoint for a Data Router Feed
2119 Create a of `Feed` object.
2135 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2139 .. code-block:: javascript
2142 "dcaeLocationName": "somestring",
2143 "feedId": "somestring",
2144 "lastMod": "2015-01-01T15:00:00.000Z",
2145 "pubId": "somestring",
2147 "statusValid": true,
2148 "username": "somestring",
2149 "userpwd": "somestring"
2158 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2162 .. code-block:: javascript
2166 "fields": "somestring",
2168 "message": "somestring"
2175 DELETE ``/feeds/{id}``
2176 ----------------------
2189 Delete a `Feed` object, specified by id.
2196 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2197 :widths: 20, 15, 10, 10, 10, 20, 30
2199 id | path | Yes | string | | |
2212 successful operation
2215 Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
2219 .. code-block:: javascript
2222 "asprClassification": "somestring",
2227 "feedDescription": "somestring",
2228 "feedId": "somestring",
2229 "feedName": "somestring",
2230 "feedVersion": "somestring",
2231 "formatUuid": "somestring",
2232 "lastMod": "2015-01-01T15:00:00.000Z",
2233 "logURL": "somestring",
2234 "owner": "somestring",
2235 "publishURL": "somestring",
2238 "dcaeLocationName": "somestring",
2239 "feedId": "somestring",
2240 "lastMod": "2015-01-01T15:00:00.000Z",
2241 "pubId": "somestring",
2243 "statusValid": true,
2244 "username": "somestring",
2245 "userpwd": "somestring"
2248 "dcaeLocationName": "somestring",
2249 "feedId": "somestring",
2250 "lastMod": "2015-01-01T15:00:00.000Z",
2251 "pubId": "somestring",
2253 "statusValid": true,
2254 "username": "somestring",
2255 "userpwd": "somestring"
2259 "statusValid": true,
2266 "dcaeLocationName": "somestring",
2267 "deliveryURL": "somestring",
2268 "feedId": "somestring",
2269 "lastMod": "2015-01-01T15:00:00.000Z",
2270 "logURL": "somestring",
2271 "owner": "somestring",
2273 "statusValid": true,
2274 "subId": "somestring",
2277 "username": "somestring",
2278 "userpwd": "somestring"
2285 "dcaeLocationName": "somestring",
2286 "deliveryURL": "somestring",
2287 "feedId": "somestring",
2288 "lastMod": "2015-01-01T15:00:00.000Z",
2289 "logURL": "somestring",
2290 "owner": "somestring",
2292 "statusValid": true,
2293 "subId": "somestring",
2296 "username": "somestring",
2297 "userpwd": "somestring"
2300 "subscribeURL": "somestring",
2310 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2314 .. code-block:: javascript
2317 "dcaeLocationName": "somestring",
2318 "feedId": "somestring",
2319 "lastMod": "2015-01-01T15:00:00.000Z",
2320 "pubId": "somestring",
2322 "statusValid": true,
2323 "username": "somestring",
2324 "userpwd": "somestring"
2333 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2337 .. code-block:: javascript
2341 "fields": "somestring",
2343 "message": "somestring"
2364 Retrieve a `Feed` object, specified by id.
2371 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2372 :widths: 20, 15, 10, 10, 10, 20, 30
2374 id | path | Yes | string | | |
2390 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2394 .. code-block:: javascript
2397 "dcaeLocationName": "somestring",
2398 "feedId": "somestring",
2399 "lastMod": "2015-01-01T15:00:00.000Z",
2400 "pubId": "somestring",
2402 "statusValid": true,
2403 "username": "somestring",
2404 "userpwd": "somestring"
2413 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2417 .. code-block:: javascript
2421 "fields": "somestring",
2423 "message": "somestring"
2444 Returns array of `Feed` objects.
2451 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2452 :widths: 20, 15, 10, 10, 10, 20, 30
2454 feedName | query | No | string | | |
2455 version | query | No | string | | |
2456 match | query | No | string | | |
2472 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2476 .. code-block:: javascript
2479 "dcaeLocationName": "somestring",
2480 "feedId": "somestring",
2481 "lastMod": "2015-01-01T15:00:00.000Z",
2482 "pubId": "somestring",
2484 "statusValid": true,
2485 "username": "somestring",
2486 "userpwd": "somestring"
2495 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2499 .. code-block:: javascript
2503 "fields": "somestring",
2505 "message": "somestring"
2526 Update a `Feed` object, specified by id.
2533 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2534 :widths: 20, 15, 10, 10, 10, 20, 30
2536 id | path | Yes | string | | |
2552 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2556 .. code-block:: javascript
2559 "dcaeLocationName": "somestring",
2560 "feedId": "somestring",
2561 "lastMod": "2015-01-01T15:00:00.000Z",
2562 "pubId": "somestring",
2564 "statusValid": true,
2565 "username": "somestring",
2566 "userpwd": "somestring"
2575 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2579 .. code-block:: javascript
2583 "fields": "somestring",
2585 "message": "somestring"
2595 Endpoint for this instance of DBCL. Returns health info.
2615 returns the `info` object
2631 Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
2635 .. code-block:: javascript
2638 "accessKeyOwner": "somestring",
2639 "bridgeAdminTopic": "somestring",
2640 "dmaapName": "somestring",
2641 "drProvUrl": "somestring",
2642 "lastMod": "2015-01-01T15:00:00.000Z",
2643 "loggingUrl": "somestring",
2644 "nodeKey": "somestring",
2646 "statusValid": true,
2647 "topicNsRoot": "somestring",
2648 "version": "somestring"
2657 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2661 .. code-block:: javascript
2665 "fields": "somestring",
2667 "message": "somestring"
2677 Endpoint for a Message Router Client that implements a Publisher or a Subscriber
2683 POST ``/mr_clients``
2684 --------------------
2690 return MR_Client details
2697 Create a `MR_Client` object.
2713 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2717 .. code-block:: javascript
2720 "dcaeLocationName": "somestring",
2721 "feedId": "somestring",
2722 "lastMod": "2015-01-01T15:00:00.000Z",
2723 "pubId": "somestring",
2725 "statusValid": true,
2726 "username": "somestring",
2727 "userpwd": "somestring"
2736 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2740 .. code-block:: javascript
2744 "fields": "somestring",
2746 "message": "somestring"
2753 DELETE ``/mr_clients/{subId}``
2754 ------------------------------
2760 return MR_Client details
2767 Delete a `MR_Client` object, specified by clientId
2774 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2775 :widths: 20, 15, 10, 10, 10, 20, 30
2777 subId | path | Yes | string | | |
2790 successful operation
2793 Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
2797 .. code-block:: javascript
2804 "clientRole": "somestring",
2805 "dcaeLocationName": "somestring",
2806 "fqtn": "somestring",
2807 "lastMod": "2015-01-01T15:00:00.000Z",
2808 "mrClientId": "somestring",
2810 "statusValid": true,
2811 "topicURL": "somestring"
2820 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2824 .. code-block:: javascript
2827 "dcaeLocationName": "somestring",
2828 "feedId": "somestring",
2829 "lastMod": "2015-01-01T15:00:00.000Z",
2830 "pubId": "somestring",
2832 "statusValid": true,
2833 "username": "somestring",
2834 "userpwd": "somestring"
2843 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2847 .. code-block:: javascript
2851 "fields": "somestring",
2853 "message": "somestring"
2867 return MR_Client details
2874 Returns array of `MR_Client` objects.
2890 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2894 .. code-block:: javascript
2897 "dcaeLocationName": "somestring",
2898 "feedId": "somestring",
2899 "lastMod": "2015-01-01T15:00:00.000Z",
2900 "pubId": "somestring",
2902 "statusValid": true,
2903 "username": "somestring",
2904 "userpwd": "somestring"
2913 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2917 .. code-block:: javascript
2921 "fields": "somestring",
2923 "message": "somestring"
2930 GET ``/mr_clients/{subId}``
2931 ---------------------------
2937 return MR_Client details
2944 Retrieve a `MR_Client` object, specified by clientId
2951 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
2952 :widths: 20, 15, 10, 10, 10, 20, 30
2954 subId | path | Yes | string | | |
2970 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
2974 .. code-block:: javascript
2977 "dcaeLocationName": "somestring",
2978 "feedId": "somestring",
2979 "lastMod": "2015-01-01T15:00:00.000Z",
2980 "pubId": "somestring",
2982 "statusValid": true,
2983 "username": "somestring",
2984 "userpwd": "somestring"
2993 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
2997 .. code-block:: javascript
3001 "fields": "somestring",
3003 "message": "somestring"
3010 PUT ``/mr_clients/{clientId}``
3011 ------------------------------
3017 return MR_Client details
3024 Update a `MR_Client` object, specified by clientId
3031 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3032 :widths: 20, 15, 10, 10, 10, 20, 30
3034 clientId | path | Yes | string | | |
3050 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3054 .. code-block:: javascript
3057 "dcaeLocationName": "somestring",
3058 "feedId": "somestring",
3059 "lastMod": "2015-01-01T15:00:00.000Z",
3060 "pubId": "somestring",
3062 "statusValid": true,
3063 "username": "somestring",
3064 "userpwd": "somestring"
3073 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3077 .. code-block:: javascript
3081 "fields": "somestring",
3083 "message": "somestring"
3093 Endpoint for a Message Router servers in a Cluster configuration
3099 POST ``/mr_clusters``
3100 ---------------------
3106 return MR_Cluster details
3113 Create an `MR_Cluster` object.
3129 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3133 .. code-block:: javascript
3136 "dcaeLocationName": "somestring",
3137 "feedId": "somestring",
3138 "lastMod": "2015-01-01T15:00:00.000Z",
3139 "pubId": "somestring",
3141 "statusValid": true,
3142 "username": "somestring",
3143 "userpwd": "somestring"
3152 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3156 .. code-block:: javascript
3160 "fields": "somestring",
3162 "message": "somestring"
3169 DELETE ``/mr_clusters/{clusterId}``
3170 -----------------------------------
3176 return MR_Cluster details
3183 Delete an `MR_Cluster` object, specified by clusterId.
3190 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3191 :widths: 20, 15, 10, 10, 10, 20, 30
3193 clusterId | path | Yes | string | | |
3206 successful operation
3209 Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
3213 .. code-block:: javascript
3216 "dcaeLocationName": "somestring",
3217 "fqdn": "somestring",
3222 "lastMod": "2015-01-01T15:00:00.000Z",
3224 "statusValid": true,
3225 "topicPort": "somestring",
3226 "topicProtocol": "somestring"
3235 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3239 .. code-block:: javascript
3242 "dcaeLocationName": "somestring",
3243 "feedId": "somestring",
3244 "lastMod": "2015-01-01T15:00:00.000Z",
3245 "pubId": "somestring",
3247 "statusValid": true,
3248 "username": "somestring",
3249 "userpwd": "somestring"
3258 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3262 .. code-block:: javascript
3266 "fields": "somestring",
3268 "message": "somestring"
3275 GET ``/mr_clusters/{clusterId}``
3276 --------------------------------
3282 return MR_Cluster details
3289 Retrieve an `MR_Cluster` object, specified by clusterId.
3296 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3297 :widths: 20, 15, 10, 10, 10, 20, 30
3299 clusterId | path | Yes | string | | |
3315 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3319 .. code-block:: javascript
3322 "dcaeLocationName": "somestring",
3323 "feedId": "somestring",
3324 "lastMod": "2015-01-01T15:00:00.000Z",
3325 "pubId": "somestring",
3327 "statusValid": true,
3328 "username": "somestring",
3329 "userpwd": "somestring"
3338 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3342 .. code-block:: javascript
3346 "fields": "somestring",
3348 "message": "somestring"
3355 GET ``/mr_clusters``
3356 --------------------
3362 return MR_Cluster details
3369 Returns array of `MR_Cluster` objects.
3385 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3389 .. code-block:: javascript
3392 "dcaeLocationName": "somestring",
3393 "feedId": "somestring",
3394 "lastMod": "2015-01-01T15:00:00.000Z",
3395 "pubId": "somestring",
3397 "statusValid": true,
3398 "username": "somestring",
3399 "userpwd": "somestring"
3408 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3412 .. code-block:: javascript
3416 "fields": "somestring",
3418 "message": "somestring"
3425 PUT ``/mr_clusters/{clusterId}``
3426 --------------------------------
3432 return MR_Cluster details
3439 Update an `MR_Cluster` object, specified by clusterId.
3446 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3447 :widths: 20, 15, 10, 10, 10, 20, 30
3449 clusterId | path | Yes | string | | |
3465 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3469 .. code-block:: javascript
3472 "dcaeLocationName": "somestring",
3473 "feedId": "somestring",
3474 "lastMod": "2015-01-01T15:00:00.000Z",
3475 "pubId": "somestring",
3477 "statusValid": true,
3478 "username": "somestring",
3479 "userpwd": "somestring"
3488 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3492 .. code-block:: javascript
3496 "fields": "somestring",
3498 "message": "somestring"
3508 Endpoint for retreiving MR Topics
3521 return Topic details
3528 Create `Topic` object.
3544 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3548 .. code-block:: javascript
3551 "dcaeLocationName": "somestring",
3552 "feedId": "somestring",
3553 "lastMod": "2015-01-01T15:00:00.000Z",
3554 "pubId": "somestring",
3556 "statusValid": true,
3557 "username": "somestring",
3558 "userpwd": "somestring"
3567 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3571 .. code-block:: javascript
3575 "fields": "somestring",
3577 "message": "somestring"
3584 DELETE ``/topics/{topicId}``
3585 ----------------------------
3591 return Topic details
3598 Delete a `Topic` object, identified by topicId
3605 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3606 :widths: 20, 15, 10, 10, 10, 20, 30
3608 topicId | path | Yes | string | | |
3621 successful operation
3624 Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
3628 .. code-block:: javascript
3641 "clientRole": "somestring",
3642 "dcaeLocationName": "somestring",
3643 "fqtn": "somestring",
3644 "lastMod": "2015-01-01T15:00:00.000Z",
3645 "mrClientId": "somestring",
3647 "statusValid": true,
3648 "topicURL": "somestring"
3655 "clientRole": "somestring",
3656 "dcaeLocationName": "somestring",
3657 "fqtn": "somestring",
3658 "lastMod": "2015-01-01T15:00:00.000Z",
3659 "mrClientId": "somestring",
3661 "statusValid": true,
3662 "topicURL": "somestring"
3665 "formatUuid": "somestring",
3666 "fqtn": "somestring",
3667 "fqtnStyle": "FQTN_NOT_SPECIFIED",
3668 "globalMrURL": "somestring",
3669 "lastMod": "2015-01-01T15:00:00.000Z",
3671 "owner": "somestring",
3672 "replicationCase": "REPLICATION_NOT_SPECIFIED",
3674 "statusValid": true,
3675 "tnxEnabled": "somestring",
3676 "topicDescription": "somestring",
3677 "topicName": "somestring",
3678 "version": "somestring"
3687 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3691 .. code-block:: javascript
3694 "dcaeLocationName": "somestring",
3695 "feedId": "somestring",
3696 "lastMod": "2015-01-01T15:00:00.000Z",
3697 "pubId": "somestring",
3699 "statusValid": true,
3700 "username": "somestring",
3701 "userpwd": "somestring"
3710 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3714 .. code-block:: javascript
3718 "fields": "somestring",
3720 "message": "somestring"
3727 GET ``/topics/{topicId}``
3728 -------------------------
3734 return Topic details
3741 Retrieve a `Topic` object, identified by topicId
3748 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3749 :widths: 20, 15, 10, 10, 10, 20, 30
3751 topicId | path | Yes | string | | |
3767 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3771 .. code-block:: javascript
3774 "dcaeLocationName": "somestring",
3775 "feedId": "somestring",
3776 "lastMod": "2015-01-01T15:00:00.000Z",
3777 "pubId": "somestring",
3779 "statusValid": true,
3780 "username": "somestring",
3781 "userpwd": "somestring"
3790 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3794 .. code-block:: javascript
3798 "fields": "somestring",
3800 "message": "somestring"
3814 return Topic details
3821 Returns array of `Topic` objects.
3837 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3841 .. code-block:: javascript
3844 "dcaeLocationName": "somestring",
3845 "feedId": "somestring",
3846 "lastMod": "2015-01-01T15:00:00.000Z",
3847 "pubId": "somestring",
3849 "statusValid": true,
3850 "username": "somestring",
3851 "userpwd": "somestring"
3860 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3864 .. code-block:: javascript
3868 "fields": "somestring",
3870 "message": "somestring"
3877 PUT ``/topics/{topicId}``
3878 -------------------------
3884 return Topic details
3891 Update a `Topic` object, identified by topicId
3898 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
3899 :widths: 20, 15, 10, 10, 10, 20, 30
3901 topicId | path | Yes | string | | |
3917 Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
3921 .. code-block:: javascript
3924 "dcaeLocationName": "somestring",
3925 "feedId": "somestring",
3926 "lastMod": "2015-01-01T15:00:00.000Z",
3927 "pubId": "somestring",
3929 "statusValid": true,
3930 "username": "somestring",
3931 "userpwd": "somestring"
3940 Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
3944 .. code-block:: javascript
3948 "fields": "somestring",
3950 "message": "somestring"
3959 .. _d_a3a7580ce9d87225d7f62e6b67b4d036:
3961 ApiError Model Structure
3962 ------------------------
3966 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
3967 :widths: 20, 10, 15, 15, 30, 25
3969 code | No | integer | int32 | |
3970 fields | No | string | | |
3971 is2xx | No | boolean | | |
3972 message | No | string | | |
3974 .. _d_d71baea9d8e4e59bc395ef51f45dff1b:
3976 BrTopic Model Structure
3977 -----------------------
3981 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
3982 :widths: 20, 10, 15, 15, 30, 25
3984 brSource | No | string | | |
3985 brTarget | No | string | | |
3986 topicCount | No | integer | int32 | |
3988 .. _d_d15e2cee407536866c875375e3f705e0:
3990 DR_Node Model Structure
3991 -----------------------
3995 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
3996 :widths: 20, 10, 15, 15, 30, 25
3998 dcaeLocationName | No | string | | |
3999 fqdn | No | string | | |
4000 hostName | No | string | | |
4001 lastMod | No | string | date-time | |
4002 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4003 statusValid | No | boolean | | |
4004 version | No | string | | |
4006 .. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
4008 DR_Pub Model Structure
4009 ----------------------
4013 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4014 :widths: 20, 10, 15, 15, 30, 25
4016 dcaeLocationName | No | string | | |
4017 feedId | No | string | | |
4018 lastMod | No | string | date-time | |
4019 pubId | No | string | | |
4020 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4021 statusValid | No | boolean | | |
4022 username | No | string | | |
4023 userpwd | No | string | | |
4025 .. _d_48cf328d246f41e1d11a09251b042f02:
4027 DR_Sub Model Structure
4028 ----------------------
4032 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4033 :widths: 20, 10, 15, 15, 30, 25
4035 bytes | No | array of string | | |
4036 dcaeLocationName | No | string | | |
4037 deliveryURL | No | string | | |
4038 feedId | No | string | | |
4039 lastMod | No | string | date-time | |
4040 logURL | No | string | | |
4041 owner | No | string | | |
4042 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4043 statusValid | No | boolean | | |
4044 subId | No | string | | |
4045 suspended | No | boolean | | |
4046 use100 | No | boolean | | |
4047 username | No | string | | |
4048 userpwd | No | string | | |
4050 .. _d_47d80e451933beb623fcf5257867cbcb:
4052 DcaeLocation Model Structure
4053 ----------------------------
4057 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4058 :widths: 20, 10, 15, 15, 30, 25
4060 central | No | boolean | | |
4061 clli | No | string | | |
4062 dcaeLayer | No | string | | |
4063 dcaeLocationName | No | string | | |
4064 lastMod | No | string | date-time | |
4065 local | No | boolean | | |
4066 openStackAvailabilityZone | No | string | | |
4067 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4068 statusValid | No | boolean | | |
4069 subnet | No | string | | |
4071 .. _d_4ea0e7758a1f8502222793e4a13b04f7:
4073 Dmaap Model Structure
4074 ---------------------
4078 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4079 :widths: 20, 10, 15, 15, 30, 25
4081 accessKeyOwner | No | string | | |
4082 bridgeAdminTopic | No | string | | |
4083 dmaapName | No | string | | |
4084 drProvUrl | No | string | | |
4085 lastMod | No | string | date-time | |
4086 loggingUrl | No | string | | |
4087 nodeKey | No | string | | |
4088 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4089 statusValid | No | boolean | | |
4090 topicNsRoot | No | string | | |
4091 version | No | string | | |
4093 .. _d_289ad39619725df26c9ff382d4c97c75:
4095 Feed Model Structure
4096 --------------------
4100 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4101 :widths: 20, 10, 15, 15, 30, 25
4103 asprClassification | No | string | | |
4104 bytes | No | array of string | | |
4105 feedDescription | No | string | | |
4106 feedId | No | string | | |
4107 feedName | No | string | | |
4108 feedVersion | No | string | | |
4109 formatUuid | No | string | | |
4110 lastMod | No | string | date-time | |
4111 logURL | No | string | | |
4112 owner | No | string | | |
4113 publishURL | No | string | | |
4114 pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
4115 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4116 statusValid | No | boolean | | |
4117 subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
4118 subscribeURL | No | string | | |
4119 suspended | No | boolean | | |
4121 .. _d_56ff81dc98986e27074d9be2731e3f4c:
4123 MR_Client Model Structure
4124 -------------------------
4128 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4129 :widths: 20, 10, 15, 15, 30, 25
4131 action | No | array of string | | |
4132 clientRole | No | string | | |
4133 dcaeLocationName | No | string | | |
4134 fqtn | No | string | | |
4135 lastMod | No | string | date-time | |
4136 mrClientId | No | string | | |
4137 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4138 statusValid | No | boolean | | |
4139 topicURL | No | string | | |
4141 .. _d_eec7176a0080debe1b19c2dad2e97c24:
4143 MR_Cluster Model Structure
4144 --------------------------
4148 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4149 :widths: 20, 10, 15, 15, 30, 25
4151 dcaeLocationName | No | string | | |
4152 fqdn | No | string | | |
4153 hosts | No | array of string | | |
4154 lastMod | No | string | date-time | |
4155 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4156 statusValid | No | boolean | | |
4157 topicPort | No | string | | |
4158 topicProtocol | No | string | | |
4160 .. _d_08fb211d40d6deb9b6e04b000fd988e4:
4162 MirrorMaker Model Structure
4163 ---------------------------
4167 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4168 :widths: 20, 10, 15, 15, 30, 25
4170 lastMod | No | string | date-time | |
4171 mmName | No | string | | |
4172 sourceCluster | No | string | | |
4173 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4174 statusValid | No | boolean | | |
4175 targetCluster | No | string | | |
4176 topicCount | No | integer | int32 | |
4177 topics | No | array of string | | |
4178 vectors | No | array of :ref:`ReplicationVector <d_56f2d64ab7d8ae64594cda45cf85f918>` | | |
4180 .. _d_56f2d64ab7d8ae64594cda45cf85f918:
4182 ReplicationVector Model Structure
4183 ---------------------------------
4187 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4188 :widths: 20, 10, 15, 15, 30, 25
4190 fqtn | No | string | | |
4191 sourceCluster | No | string | | |
4192 targetCluster | No | string | | |
4194 .. _d_2e99841971da81b9d240071b86bf168d:
4196 Topic Model Structure
4197 ---------------------
4201 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
4202 :widths: 20, 10, 15, 15, 30, 25
4204 bytes | No | array of string | | |
4205 clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | |
4206 formatUuid | No | string | | |
4207 fqtn | No | string | | |
4208 fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} |
4209 globalMrURL | No | string | | |
4210 lastMod | No | string | date-time | |
4211 numClients | No | integer | int32 | |
4212 owner | No | string | | |
4213 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']} |
4214 status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
4215 statusValid | No | boolean | | |
4216 tnxEnabled | No | string | | |
4217 topicDescription | No | string | | |
4218 topicName | No | string | | |
4219 version | No | string | | |