Devops

Send a piggyback command to a specific service

POST

https://ditto.eclipseprojects.io/devops/piggyback/{serviceName}

curl -X POST 'https://ditto.eclipseprojects.io/devops/piggyback/things' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '"{\n  \"targetActorSelection\": \"/user/<SERVICE_NAME>Root/persistenceCleanup\",\n  \"headers\": {},\n  \"piggybackCommand\": {\n    \"type\": \"status.commands:retrieveHealth\"\n  }\n}"'

const response = await fetch('https://ditto.eclipseprojects.io/devops/piggyback/things', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body: '"{\\n  \\"targetActorSelection\\": \\"/user/<SERVICE_NAME>Root/persistenceCleanup\\",\\n  \\"headers\\": {},\\n  \\"piggybackCommand\\": {\\n    \\"type\\": \\"status.commands:retrieveHealth\\"\\n  }\\n}"',
});

const data = await response.text();

import requests

response = requests.post(
    'https://ditto.eclipseprojects.io/devops/piggyback/things',
    data='"{\\n  \\"targetActorSelection\\": \\"/user/<SERVICE_NAME>Root/persistenceCleanup\\",\\n  \\"headers\\": {},\\n  \\"piggybackCommand\\": {\\n    \\"type\\": \\"status.commands:retrieveHealth\\"\\n  }\\n}"'.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

Query background cleanup coordinator state

"{\n  \"targetActorSelection\": \"/user/<SERVICE_NAME>Root/persistenceCleanup\",\n  \"headers\": {},\n  \"piggybackCommand\": {\n    \"type\": \"status.commands:retrieveHealth\"\n  }\n}"

"{\n  \"things\": {\n    \"ditto-things-65f6dd5d7-htkwt\": {\n      \"type\": \"status.responses:retrieveHealth\",\n      \"status\": 200,\n      \"statusInfo\": {\n        \"status\": \"UP\",\n        \"details\": [\n          {\n            \"INFO\": {\n              \"state\": \"IN_QUIET_PERIOD\",\n              \"pid\": \"\"\n              }\n          }\n        ]\n      }\n    }\n  }\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

serviceNamestringthingspoliciesconnectivityrequiredpath

Specified service target for the command execution

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

Return The current value of logging level

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