Dynamic Engine Environments

Manage and assign your Environments to Dynamic Engines.

Media type

application/json

Endpoints

https://api.eu.cloud.talend.com
URL for the AWS Europe region
https://api.ap.cloud.talend.com
URL for the AWS Asia Pacific region
https://api.us.cloud.talend.com
URL for the AWS United States East region
https://api.au.cloud.talend.com
URL for the AWS Australia region
https://api.us-west.cloud.talend.com
URL for the Azure United States West region

Global security

These security schemes apply to the entire API

No authentication

While providing all capacity related to Environments (see description), Dynamic Engine Environment also brings Dynamic Engine processing for all tasks or plans defined within.

This processing capacity is provided through the assignment of your Environment to one (and one only) available Dynamic Engine. Doing so, you dont need to provide any Engine definition on the task level.

This processing capacity is exclusive, meaning all tasks or plans defined in your Environment will target this Dynamic Engine for execution.

The status as defined here on Dynamic Engine Environment reflects both this assignment state and the processing readiness state.

Object

Name	Description	Type	Attributes and examples
id	Unique identifier	string Required
name	Unique name	string Required
description	Description	string Required
deId	Identifier of the Dynamic Engine this Environment might be connected to	string Optional
status	Status of your Dynamic Engine Environment. Possible statuses are the following : Not Assigned : Environment can be used for any Orchestration/configuration action : add workspace, etc. Set Up Required : Transitional state. Some DE link is configured but technical setup is still required in order for Processing to be available for your Environment. Please ask your Infra Admin. Ready : Ressources for your Environment have been installed successfully. Processing is fully available. Not Ready : Error state. DE link is configured but some error occured on Dynamic Engine. Please check with your Infra Admin.	string Required	Enum NOT_ASSIGNED SETUP_REQUIRED READY NOT_READY
logStrategy	DynamicEngine Strategy on logs regarding this Environment’s executions	string Required	Enum NONE CONTROL_PLANE
metricsStrategy	DynamicEngine Strategy on metrics regarding this Environment’s executions	string Required	Enum NONE CONTROL_PLANE
createdBy	Username of user who created Dynamic Engine Environment	string Optional	Example admin
creationDate	Creation Date of Dynamic Engine Environment	datetime Optional	Example "2023-10-24T10:49:00.658Z"
lastModifiedBy	Username of user who last updated Dynamic Engine Environment	string Optional	Example admin
lastModifiedDate	Date of the last modification made by user	datetime Optional	Example "2023-10-24T12:36:58.503Z"
creatorType	Type of user who created Dynamic Engine Environment, either HUMAN or SERVICE_ACCOUNT	string Optional	Example SERVICE_ACCOUNT
modifierType	Type of user who last modified Dynamic Engine Environment, either HUMAN or SERVICE_ACCOUNT	string Optional	Example HUMAN
linkId	Dynamic Engine Assignment link unique id. Unmutable data allowing to setup and cleanup resources on the Dynamic Engine for your Environment.	string Optional

Object

Name	Description	Type	Attributes and examples
status	status code	integer Required	FormatINT32
message		string Required
details		string Optional
code		string Optional
uri		string Optional
requestId		string Optional

Object

Name	Description	Type	Attributes and examples
name		string Required
description		string Optional
workspaceName		string Required
owner		string Optional
logStrategy	default value is NONE	string Optional	Enum NONE CONTROL_PLANE
metricsStrategy	default value is NONE	string Optional	Enum NONE CONTROL_PLANE

Object

Name	Description	Type	Attributes and examples
name	like filter on name	string Optional
deId	Dynamic Engine identifier	string Optional
limit		integer Optional	FormatINT32
offset		integer Optional	FormatINT32
sortOrder	sort order of fetched dynamic engine environments	string Optional	DefaultDESC Examples DESC ASC
sortBy	attribute dynamic engine environments are sorted by, sorted by creation time by default	string Optional	Examples "status" "name"

Object

Name	Type	Attributes and examples
name	string Optional
description	string Optional
logStrategy	string Optional	Enum NONE CONTROL_PLANE
metricsStrategy	string Optional	Enum NONE CONTROL_PLANE

Object

data

array of DEEnvironment Optional

Datatype details
Type	Description	Attributes and examples
array
DEEnvironment

limit

integer Optional

offset

integer Optional

totalLength

integer Optional

Create new Dynamic Engine Environment

POST /orchestration/dynamic-engine-environments

A Dynamic Engine Environment is an Environment that can be assigned to one Dynamic Engine.

While keeping all existing capability available on Environments, it also brings Dynamic Engine targeted executions : once connected, all executions of any task or plan defined within this Environment will occur on the assigned Dynamic Engine. Please consult Connection sub-resource to learn more about Dynamic Engine connection facility.

Pre-requisites :

User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.
environment name must be unique (leading or trailing spaces are removed)

Use cases

Adding a Dynamic Engine instance and its environment

Request

Body

CreateDynamicEngineEnvironmentRequest

Response

201Status 201

Body

DEEnvironment

400Status 400

Incorrect request

Body