Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleDelete Mirror Maker

POST /mirrormakers/delete

This API is used to delete an existing MirrorMaker. 

Required AAF Permissions: org.onap.dmaap.mr.mirrormaker|*|admin

Request:

Request Payload:

Parameter NameReq'dDescription
deleteMirrorMakerYMirror Maker Request Object
NameYExisting MirrorMaker name

{
"deleteMirrorMaker":
{
"name":"centraltoedge2"
}
}


Response Payload:


"listMirrorMaker": [
{
"name": "centraltoedge",
"producer": "10.12.5.108:30491",
"whitelist": "org.onap.dmaap.mr.mrtesttopic",
"enablelogCheck": true,
"consumer": "10.12.6.98:30491",
"status": "RUNNING",
"numStreams": 3
}
],
"messageID": "99310"
}


Error Messages:

Error ReasonError Message
No AAF Mirror Maker Admin permissionNo Mirror Maker Admin permission.
Incorrect MirrorMaker name that does not exist MirrorMaker <MM Name> does not exist
Incorrect payloadThis is not a DeleteMirrorMaker request. Please try again.
Incorrect JSONIncorrect JSON object.Could not parse JSON. Please correct the JSON format and try again.
If Mirror Maker agent is down or it takes more than (right now it is configured 15 second)listMirrorMaker is not available, please make sure MirrorMakerAgent is running.



WhiteList


Expand
titleCreate Whitelist

POST /mirrormakers/createwhitelist

This API is used to add a new topic  to the whitelist.

AAF permissions required: org.onap.dmaap.mr.mirrormaker|*|user ,  org.onap.dmaap.mr.topicFactory|:org.onap.dmaap.mr.topic:org.onap.dmaap.mr|create

Request Payload:

Parameter NameReq'dDescription
nameYMirror Maker name
namespaceYa namespace
whitelistTopicNameYa topic name that contains only alpha numeric value

{
"name":"centraltoedge",
"namespace":"org.onap.dmaap.mr",
"whitelistTopicName":"org.onap.dmaap.mr.mrtesttopic2"
}


Response Payload:

{
"listMirrorMaker": [
{
"name": "centraltoedge",
"producer": "10.12.5.108:30491",
"whitelist": "org.onap.dmaap.mr.mrtesttopic,org.onap.dmaap.mr.mrtesttopic2",
"enablelogCheck": true,
"consumer": "10.12.6.98:30491",
"status": "RESTARTING",
"numStreams": 3
}
],
}


Error Messages:

Error ReasonError Message
No AAF Mirror Maker User permissionNo Mirror Maker User permission.
No AAF Mirror Maker User Create permission (User should have create topics permission ont he namespace listed)No Mirror Maker User Create permission.
Incorrect JSONIncorrect JSON object.Could not parse JSON. Please correct the JSON format and try again.
Request contain topic that already existThe topic already exist.
If the namespace in the topic does not match with the namespace in the requestThe namespace of the topic does not match with the namespace you provided.
If Mirror Maker agent is down or it takes more than (right now it is configured 15 second)listWhiteList is not available, please make sure MirrorMakerAgent is running
Incorrect payloadThis is not a createWhitelist request. Please try again.


...