Devops

Send a piggyback command

POST

https://ditto.eclipseprojects.io/devops/piggyback

Send a piggyback command to Pekko’s pub-sub-mediator

curl -X POST 'https://ditto.eclipseprojects.io/devops/piggyback' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '"{\n  \"targetActorSelection\": \"/system/distributedPubSubMediator\",\n  \"headers\": {\n    \"aggregate\": false\n  },\n  \"piggybackCommand\": {\n    \"type\": \"namespaces.commands:blockNamespace\",\n    \"namespace\": \"namespaceToBlock\"\n  }\n}"'

const response = await fetch('https://ditto.eclipseprojects.io/devops/piggyback', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body: '"{\\n  \\"targetActorSelection\\": \\"/system/distributedPubSubMediator\\",\\n  \\"headers\\": {\\n    \\"aggregate\\": false\\n  },\\n  \\"piggybackCommand\\": {\\n    \\"type\\": \\"namespaces.commands:blockNamespace\\",\\n    \\"namespace\\": \\"namespaceToBlock\\"\\n  }\\n}"',
});

const data = await response.text();

import requests

response = requests.post(
    'https://ditto.eclipseprojects.io/devops/piggyback',
    data='"{\\n  \\"targetActorSelection\\": \\"/system/distributedPubSubMediator\\",\\n  \\"headers\\": {\\n    \\"aggregate\\": false\\n  },\\n  \\"piggybackCommand\\": {\\n    \\"type\\": \\"namespaces.commands:blockNamespace\\",\\n    \\"namespace\\": \\"namespaceToBlock\\"\\n  }\\n}"'.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

Block all messages to a namespace

"{\n  \"targetActorSelection\": \"/system/distributedPubSubMediator\",\n  \"headers\": {\n    \"aggregate\": false\n  },\n  \"piggybackCommand\": {\n    \"type\": \"namespaces.commands:blockNamespace\",\n    \"namespace\": \"namespaceToBlock\"\n  }\n}"

Shutdown all actors in a namespace

"{\n  \"targetActorSelection\": \"/system/distributedPubSubMediator\",\n  \"piggybackCommand\": {\n    \"type\": \"common.commands:shutdown\",\n    \"reason\": {\n      \"type\": \"purge-namespace\",\n      \"details\": \"namespaceToShutdown\"\n    }\n  }\n}"

Erase all data in a namespace from the persistence

"{\n  \"targetActorSelection\": \"/system/distributedPubSubMediator\",\n  \"headers\": {\n    \"aggregate\": true,\n    \"is-group-topic\": true\n  },\n  \"piggybackCommand\": {\n    \"type\": \"namespaces.commands:purgeNamespace\",\n    \"namespace\": \"namespaceToPurge\"\n  }\n}"

Unblock messages to a namespace

"{\n  \"targetActorSelection\": \"/system/distributedPubSubMediator\",\n  \"headers\": {\n    \"aggregate\": false\n  },\n  \"piggybackCommand\": {\n    \"type\": \"namespaces.commands:unblockNamespace\",\n    \"namespace\": \"namespaceToUnblock\"\n  }\n}"

"{\n  \"type\": \"namespaces.responses:blockNamespace\",\n  \"status\": 200,\n  \"namespace\": \"namespaceToBlock\",\n  \"resourceType\": \"namespaces\"\n}"

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

The supplied authentication is invalid

Body

application/json

Fields to send a command

targetActorSelectionstring

headersobject

Show child attributes

aggregatebooleanfalse

is-group-topicbooleantrue

piggybackCommandobject

Show child attributes

typestring

Parameters

timeoutstringquery

Defines how long the backend should wait for completion of the request, e.g. applied when waiting for requested acknowledgements via the requested-acks param. Can be specified without unit (then seconds are assumed) or together with s, ms or m unit. Example: 42s, 1m.

The default (if omitted) and maximum timeout is 60s. A value of 0 applies fire and forget semantics for the command resulting in setting response-required=false.

Response

200OKPiggybackManagingBackgroundCleanup

Response of command

Response fields application/json

targetActorSelectionstring

headersobject

Show child attributes

aggregatebooleanfalse

is-group-topicbooleantrue

piggybackCommandobject

Show child attributes

typestring

400Bad RequestAdvancedError

The request could not be completed. At least one of the defined query parameters was invalid.

Response fields application/json

statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

401UnauthorizedTextUnauthorizeError

The request could not be completed due to missing authentication.

Response fields text/plain

TextUnauthorizeError

Example

The supplied authentication is invalid

Authorization

DevOpsBasichttp (basic)

Eclipse Ditto devops user (devops) + password (foobar)

DevOpsBearerhttp (bearer)

A JSON Web Token issued by a supported OAuth 2.0 Identity Provider for the Eclipse Ditto devops user.

Docs by Sourcey