Devops

Retrieving the configuration of a specific service instance.

GET

https://ditto.eclipseprojects.io/devops/config/{moduleName}/{podName}

Return the configuration of a specific service instance.

curl -X GET 'https://ditto.eclipseprojects.io/devops/config/gateway/ditto-gateway-764fc5f474-qrm2r' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://ditto.eclipseprojects.io/devops/config/gateway/ditto-gateway-764fc5f474-qrm2r', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://ditto.eclipseprojects.io/devops/config/gateway/ditto-gateway-764fc5f474-qrm2r',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

"{\n  \"gateway\": {\n    \"podName\": {\n      \"type\": \"common.responses:retrieveConfig\",\n      \"status\": 200,\n      \"config\": {\n        \"cluster\": {\n          \"cluster-status-roles-blocklist\": [\n              \"cluster1\",\n              \"......\" ,\n              \"clusterN\"\n          ],\n          \"number-of-shards\": 20\n        },\n        \"ddata\": {\n          \"vm arg1\": \"string\",\n          \".............\": \"string\",\n          \"vm argn\" : \"string\"\n        },\n        \"devops\": {\n          \"feature\": {\n            \"merge-things-enabled\": true\n          },\n          \"namespace\": {\n            \"block-time\": \"string\"\n          }\n        },\n        \"gateway\": {\n          \"authentication\": {\n            \"devops\": {\n              \"devops-authentication-method\": \"string\",\n              \"password\": \"string\",\n              \"secured\": true,\n              \"status-authentication-method\": \"string\",\n              \"statusPassword\": \"string\"\n            },\n            \"http\": {\n              \"proxy\": {\n                \"enabled\": false\n              }\n            },\n            \"oauth\": {\n              \"allowed-clock-skew\": \"string\",\n              \"openid-connect-issuers\": {\n                \"google\": {\n                  \"issuer\": \"string\"\n                }\n              },\n              \"protocol\": \"https\",\n              \"token-integration-subject\": \"string\"\n            },\n            \"pre-authentication\": {\n              \"enabled\": \"true\"\n            }\n          }\n        }\n      }\n    }\n  }\n}"

The supplied authentication is invalid

Parameters

moduleNamestringrequiredpath

The name of module

podNamestringrequiredpath

The name of pod

pathstringquery

The path points to information on service name, service instance index, JVM arguments and environment variables.

Response

200OKArray<RetrieveConfigService>

Return The current value of specific service instance.

Response fields application/json

Array<RetrieveConfigService>

Show child attributes

gatewayModuleConfigService

Module

Show child attributes

podResultConfigService

Details of specific service instance.

Show child attributes

typestring

devops.responses:ResultConfigService

statusinteger

The HTTP status

configobject

name of service

Show child attributes

clusterany

Show child attributes

number-of-shardsinteger

gatewayany

Show child attributes

authenticationobject

Show child attributes

devopsobject

Show child attributes

passwordstring

securedboolean

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