Dynamic Engine

Manage Dynamic Engines

Endpoints

Global security

These security schemes apply to the entire API

Security scheme

This scheme can be referenced across the API

Public
Bearer authentication
Name Description
Format Bearer <jwt>

Update a Dynamic Engine instance

PUT /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
id The dynamic-engine’s id string Required
Body
application/json
UpdateDynamicEngineRequest

Response

200Status 200
OK
Body
application/json
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
409Status 409
There is already an ongoing operation for this dynamic-engine
Body
application/json
ApiError

Get a Dynamic Engine instance by its ID

GET /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT or DYN_ENGINE_READ

Request

Path variables
Name Description Type Attributes and examples
id The dynamic-engine’s id string Required

Response

200Status 200
OK
Body
application/json
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Not Found
Body
application/json
ApiError

Delete a Dynamic Engine instance

DELETE /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
id The dynamic-engine’s id string Required

Response

200Status 200
OK
202Status 202
Accepted
Body
application/json
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Get all your Dynamic Engine instances

GET /processing/runtimes/dynamic-engines
Required entitlement TMC_CLUSTER_MANAGEMENT or TMC_RUN_PROFILE_MANAGEMENT or TMC_ENVIRONMENT_MANAGEMENT

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of DynamicEngineDetailsResponse
Datatype details
Type Description Attributes and examples
array
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Create a new Dynamic Engine instance

POST /processing/runtimes/dynamic-engines
Required entitlement TMC_CLUSTER_MANAGEMENT

Use cases

Request

Body
application/json
one of CreateDynamicEngineRequest

Response

201Status 201
Created
Body
application/json
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Return the manifest for the infrastructure and all associated environments

POST /processing/runtimes/dynamic-engines/{dynamicEngineId}/actions/generate-manifest
This endpoint returns the manifest for the infrastructure and all the environments associated with the given Dynamic Engine instance.

Use cases

Request

Path variables
Name Description Type Attributes and examples
dynamicEngineId The dynamic-engine’s id string Required
Example
c-c97f8
Body
application/json
GenerateManifestOptions

Response

200Status 200
OK
Body
application/zip
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Dynamic-engine does not exist or doesn’t have any status yet
Body
application/zip
ApiError
500Status 500
Internal Server Error
Body
application/json
ApiError

Fetch the Dynamic Engine infrastructure status

GET /processing/runtimes/dynamic-engines/{dynamicEngineId}/infra/status
The status is the runtime state of common services belonging to the qlik-dynamic-engine namespace, such as the dynamic-engine operator.

Request

Path variables
Name Description Type Attributes and examples
dynamicEngineId The dynamic-engine’s id string Required
Example
c-c97f8

Response

200Status 200
OK
Body
application/json
StatusResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Dynamic-engine does not exist or doesn’t have any status yet
Body
application/json
ApiError
500Status 500
Internal Server Error
Body
application/json
ApiError

Fetch the Dynamic Engine environment status

GET /processing/runtimes/dynamic-engines/{dynamicEngineId}/environments/{environmentId}/status
The status is the runtime state of processing services belonging to an environment assigned to the given Dynamic Engine instance.

Request

Path variables
Name Description Type Attributes and examples
dynamicEngineId The dynamic engine’s id string Required
Example
c-c97f8
environmentId The environment’s id string Required
Example
664b0bbd6c6f5522732e055d

Response

200Status 200
OK
Body
application/json
StatusResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Environment does not exist or is not associated to a dynamic engine
Body
application/json
ApiError
500Status 500
Internal Server Error
Body
application/json
ApiError

Return all supported Dynamic Engine versions.

GET /processing/runtimes/dynamic-engine-versions
A Dynamic Engine version is a consistent baseline of processing services that can be used to generate a deployment manifest.

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of DynamicEngineVersion
Datatype details
Type Description Attributes and examples
array
DynamicEngineVersion
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
500Status 500
Internal Server Error
Body
application/json
ApiError

Delete an environment assignment.

DELETE /processing/runtimes/dynamic-engines/{dynamicEngineId}/environments/{environmentId}
This removes the association between the given environment and the given Dynamic Engine instance.

Request

Path variables
Name Description Type Attributes and examples
dynamicEngineId The dynamic engine’s id string Required
Example
c-c97f8
environmentId The environment’s id string Required
Example
664b0bbd6c6f5522732e055d

Response

202Status 202
Accepted
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Environment does not exist or is not associated to a dynamic engine
Body
application/json
ApiError
409Status 409
There is already an ongoing operation for this environment
Body
application/json
ApiError
500Status 500
Internal Server Error
Body
application/json
ApiError

ApiError

Describe an API error
Object
Name Description Type Attributes and examples
status HTTP status code integer Optional
FormatINT32
Example
400
title The error’s title string Optional
Example
Bad request
details The error’s details string Optional
Example
Invalid parameter
instance The error’s instance string Optional
Example
https://api.talend.com/errors/dynamic-engine-not-found
type The error’s type string Optional
Example
https://api.talend.com/errors/error-code
code The error’s code string Optional
Example
DP_ERR_001

GenerateManifestOptions

Describe the supported options to generate a manifest for the infrastructure and all the environments
Object
Name Description Type Attributes and examples
version Requested version of the dynamic engine. Leave empty to get the latest version. Use the dynamic-engine-versions endpoint to get the list of supported versions. string Optional
Example
1.0.0
generateNewPairingKey Force-generate a new pairing key. boolean Optional

KubernetesEvent

Describe an engine event
Object
Name Description Type Attributes and examples
message The event’s message string Required
source The event’s source string Required
creationDate The event’s creation date with timezone string Required

ServiceDetails

Details of the installed service
Object
Name Description Type Attributes and examples
name The service’s name string Required
Example
remote-engine-agent
status The service’s status string Required
Enum
  • RUNNING
  • UPDATING
  • STARTING
  • NOT_DEPLOYED
  • IN_ERROR
chartVersion The service’s version string Optional
creationDate The service’s creation date with timezone string Optional
lastUpdateDate The service’s last update date with timezone string Optional
appsVersion All application’s version running in this service ObjectOptional
jobStatus The status of the job that installed the service string Optional
Enum
  • SUCCEEDED
  • FAILED
  • RUNNING
jobErrorMessage The error message of the job that installed the service string Optional

StatusResponse

Describe the status
Object
Name Description Type Attributes and examples
status The global status string Required
Enum
  • STARTING
  • RUNNING
  • UPDATING
  • STOPPING
  • NOT_FOUND
  • NOT_DEPLOYED
  • IN_ERROR
Example
RUNNING
dynamicEngineVersion The version of the dynamic engine string Optional
Example
1.0.0
jobDeleteStatus The status of the delete job string Optional
Enum
  • SUCCEEDED
  • FAILED
  • RUNNING
Example
failed
services array of ServiceDetails Optional
Datatype details
Type Description Attributes and examples
array The services details
ServiceDetails
failureEvents array of KubernetesEvent Optional
Datatype details
Type Description Attributes and examples
array The failure events
KubernetesEvent

DynamicEngineReleaseNote

Describe a dynamic engine version release note
Object
Name Description Type Attributes and examples
releaseNotesLink The link to the release note string Optional
changelogLink The link to the changelog string Optional

DynamicEngineService

Describe a dynamic engine version service
Object
Name Description Type Attributes and examples
id The id string Optional
Example
engine-operator
feature The feature string Optional
Example
infra
version The version string Optional
Example
1.0.0

DynamicEngineVersion

Describe a dynamic engine version
Object
Name Description Type Attributes and examples
id The id string Optional
name The name string Optional
publicationDate The publication date datetime Optional
FormatRFC3339
kubeVersion The supported kubernetes version string Optional
releaseNotes DynamicEngineReleaseNote Optional
services array of DynamicEngineService Optional
Datatype details
Type Description Attributes and examples
array The list of services
DynamicEngineService

UpdateDynamicEngineRequest

The request payload to update a dynamic-engine
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-dynamic-engine
description The description string Required
Max length1024
Example
dynamic-engine for QA

DynamicEngineDetailsResponse

Describe a dynamic-engine
Object
Name Description Type Attributes and examples
id The id string Required
name The name string Required
description The description string Optional
state The current state string Required
Enum
  • CREATING
  • CONNECTED
  • DISCONNECTED
  • ERROR
  • DELETED
creationDate The creation date datetime Required
FormatRFC3339
lastModifiedDate The last modified date datetime Required
FormatRFC3339
lastModifiedStateDate The last state modified date datetime Required
FormatRFC3339
createdBy The user that created this dynamic-engine string Required
lastModifiedBy The last user that modified this dynamic-engine string Required

CreateDynamicEngineRequest

The request payload to create a dynamic-engine
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-dynamic-engine
description The description string Optional
Max length1024
back to top↑