DMaaP Bus Controller REST API 1.1.0 (via swagger2doc)

Feeds

GET /feeds

return Feed details

  • Description: Returns array of `Feed` objects.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
feedName query string
version query string
match query string

Responses

200 - Success

400 - Error

POST /feeds

return Feed details

  • Description: Create a of `Feed` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
useExisting query string

Responses

200 - Success

400 - Error

PUT /feeds/sync

sync feeds to existing DR

  • Description: When Bus Controller is deployed after DR, then it is possiblethat DR has previous provisioning data that needs to be importedinto Bus Controller.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
hard query string

Responses

200 - Success

400 - Error

GET /feeds/{id}

return Feed details

  • Description: Retrieve a `Feed` object, specified by id.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
id path string

Responses

200 - Success

400 - Error

PUT /feeds/{id}

return Feed details

  • Description: Update a `Feed` object, specified by id.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
id path string

Responses

200 - Success

400 - Error

DELETE /feeds/{id}

return Feed details

  • Description: Delete a `Feed` object, specified by id.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
id path string

Responses

200 - successful operation

204 - Success

400 - Error

MR_Clients

GET /mr_clients

return MR_Client details

  • Description: Returns array of `MR_Client` objects.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /mr_clients

Associate an MR_Client object to a Topic

  • Description: Create a `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic. In legacy implementation, the `clientRole` is granted appropriate permission in AAF. Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

PUT /mr_clients/{clientId}

Update an MR_Client object

  • Description: Update a `MR_Client` object, specified by clientId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
clientId path string

Responses

200 - Success

400 - Error

GET /mr_clients/{subId}

return MR_Client details

  • Description: Retrieve a `MR_Client` object, specified by clientId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
subId path string

Responses

200 - Success

400 - Error

DELETE /mr_clients/{subId}

Delete an MR_Client object

  • Description: Delete a `MR_Client` object, specified by clientId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
subId path string

Responses

200 - successful operation

204 - Success

400 - Error

MR_Clusters

GET /mr_clusters

return MR_Cluster details

  • Description: Returns array of `MR_Cluster` objects.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /mr_clusters

return MR_Cluster details

  • Description: Create an `MR_Cluster` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

GET /mr_clusters/{clusterId}

return MR_Cluster details

  • Description: Retrieve an `MR_Cluster` object, specified by clusterId.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
clusterId path string

Responses

200 - Success

400 - Error

PUT /mr_clusters/{clusterId}

return MR_Cluster details

  • Description: Update an `MR_Cluster` object, specified by clusterId.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
clusterId path string

Responses

200 - Success

400 - Error

DELETE /mr_clusters/{clusterId}

return MR_Cluster details

  • Description: Delete an `MR_Cluster` object, specified by clusterId.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
clusterId path string

Responses

200 - successful operation

204 - Success

400 - Error

bridge

GET /bridge

return BrTopic details

  • Description: 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.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
mmagent query string
detail query boolean

Responses

200 - Success

400 - Error

PUT /bridge

update MirrorMaker details

  • Description: 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.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
mmagent query string
refresh query boolean
split query boolean

Responses

200 - Success

400 - Error

dcaeLocations

GET /dcaeLocations

return dcaeLocation details

  • Description: 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).
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /dcaeLocations

return dcaeLocation details

  • Description: Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

GET /dcaeLocations/{locationName}

return dcaeLocation details

  • Description: Returns a specific `dcaeLocation` object with specified tag
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
locationName path string

Responses

200 - Success

400 - Error

PUT /dcaeLocations/{locationName}

return dcaeLocation details

  • Description: update the openStackAvailabilityZone of a dcaeLocation
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
locationName path string

Responses

200 - Success

400 - Error

DELETE /dcaeLocations/{locationName}

return dcaeLocation details

  • Description: delete a dcaeLocation
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
locationName path string

Responses

200 - successful operation

204 - Success

400 - Error

dmaap

GET /dmaap

return dmaap details

  • Description: returns the `dmaap` object, which contains system wide configuration settings
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /dmaap

return dmaap details

  • Description: Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

PUT /dmaap

return dmaap details

  • Description: Update system settings for *dcaeEnvironment*.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

dr_nodes

GET /dr_nodes

return DR_Node details

  • Description: Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /dr_nodes

return DR_Node details

  • Description: create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

GET /dr_nodes/{fqdn}

return DR_Node details

  • Description: Retrieve a single `DR_Node` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
fqdn path string

Responses

200 - Success

400 - Error

PUT /dr_nodes/{fqdn}

return DR_Node details

  • Description: Update a single `DR_Node` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
fqdn path string

Responses

200 - Success

400 - Error

DELETE /dr_nodes/{fqdn}

No Content

  • Description: Delete a single `DR_Node` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
fqdn path string

Responses

200 - successful operation

204 - Success

400 - Error

dr_pubs

GET /dr_pubs

return DR_Pub details

  • Description: Returns array of `DR_Pub` objects. Add filter for feedId.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /dr_pubs

return DR_Pub details

  • Description: create a DR Publisher in the specified environment.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

GET /dr_pubs/{pubId}

return DR_Pub details

  • Description: returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
pubId path string

Responses

200 - Success

400 - Error

PUT /dr_pubs/{pubId}

return DR_Pub details

  • Description: update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
pubId path string

Responses

200 - Success

400 - Error

DELETE /dr_pubs/{pubId}

return DR_Pub details

  • Description: delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
pubId path string

Responses

200 - successful operation

204 - Success

400 - Error

dr_subs

GET /dr_subs

return DR_Sub details

  • Description: Returns array of `DR_Sub` objects. Add filter for feedId.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /dr_subs

return DR_Sub details

  • Description: Create a `DR_Sub` object.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

GET /dr_subs/{subId}

return DR_Sub details

  • Description: Retrieve a `DR_Sub` object, selected by subId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
subId path string

Responses

200 - Success

400 - Error

PUT /dr_subs/{subId}

return DR_Sub details

  • Description: Update a `DR_Sub` object, selected by subId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
subId path string

Responses

200 - Success

400 - Error

DELETE /dr_subs/{subId}

return DR_Sub details

  • Description: Delete a `DR_Sub` object, selected by subId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
subId path string

Responses

200 - Success

400 - Error

info

GET /info

return info details

  • Description: returns the `info` object
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

topics

GET /topics

return Topic details

  • Description: Returns array of `Topic` objects.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Responses

200 - Success

400 - Error

POST /topics

Create a Topic object

  • Description: Create `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`. Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic. MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
useExisting query string

Responses

200 - Success

400 - Error

GET /topics/{topicId}

return Topic details

  • Description: Retrieve a `Topic` object, identified by topicId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
topicId path string

Responses

200 - Success

400 - Error

PUT /topics/{topicId}

return Topic details

  • Description: Update a `Topic` object, identified by topicId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
topicId path string

Responses

200 - Success

400 - Error

DELETE /topics/{topicId}

return Topic details

  • Description: Delete a `Topic` object, identified by topicId
  • Consumes: [‘application/json’]
  • Produces: [‘application/json’]

Parameters

Name Position Description Type
topicId path string

Responses

200 - successful operation

204 - Success

400 - Error