Dynamic Engine Environments
Media type
Endpoints
- https://api.eu.cloud.talend.comURL for the AWS Europe region
- https://api.ap.cloud.talend.comURL for the AWS Asia Pacific region
- https://api.us.cloud.talend.comURL for the AWS United States East region
- https://api.au.cloud.talend.comURL for the AWS Australia region
- https://api.us-west.cloud.talend.comURL for the Azure United States West region
Global security
These security schemes apply to the entire API
- No authentication
DEEnvironment
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.
| 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 | |
| logStrategy | DynamicEngine Strategy on logs regarding this Environment’s executions | string Required | |
| metricsStrategy | DynamicEngine Strategy on metrics regarding this Environment’s executions | string Required | |
| createdBy | Username of user who created Dynamic Engine Environment | string Optional | admin |
| creationDate | Creation Date of Dynamic Engine Environment | datetime Optional | "2023-10-24T10:49:00.658Z" |
| lastModifiedBy | Username of user who last updated Dynamic Engine Environment | string Optional | admin |
| lastModifiedDate | Date of the last modification made by user | datetime Optional | "2023-10-24T12:36:58.503Z" |
| creatorType | Type of user who created Dynamic Engine Environment, either HUMAN or SERVICE | string Optional | SERVICE |
| modifierType | Type of user who last modified Dynamic Engine Environment, either HUMAN or SERVICE | string Optional | 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 |
ErrorResponse
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | HTTP status code | integer Required | 401 |
| message | Info about the error for user | string Optional | Forbidden |
| detail | Info about error for developer. | string Optional | Token authorization is required for access |
| requestId | The unique identification of the request involved with this error | string Optional | 16fefb53-035a-4249-af9d-f80a3b47b132 |
CreateDynamicEngineEnvironmentRequest
| 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 | |
| metricsStrategy | default value is NONE | string Optional |
SearchDynamicEngineEnvironmentsRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | like filter on name | string Optional | |
| deId | Dynamic Engine identifier | string Optional | |
| limit | integer Optional | INT32 | |
| offset | integer Optional | INT32 | |
| sortOrder | sort order of fetched dynamic engine environments | string Optional | DESC |
| sortBy | attribute dynamic engine environments are sorted by, sorted by creation time by default | string Optional | |
| status | Environment Dynamic Engine Connection Status | string Optional |
UpdateDynamicEngineEnvironmentRequest
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| name | string Optional | ||
| description | string Optional | ||
| logStrategy | string Optional | ||
| metricsStrategy | string Optional |
DEEnvironmentPage
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items | array of DEEnvironment Optional |
| ||||||||||
| limit | integer Optional | |||||||||||
| offset | integer Optional | |||||||||||
| total | integer Optional |
Create new Dynamic Engine Environment
POST /orchestration/dynamic-engine-environmentsA 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)
Response
Retrieves a Dynamic Engine Environment
GET /orchestration/dynamic-engine-environments/{environmentId}Pre-requisites :
- User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | string Required |
Response
Update one Dynamic Engine Environment
PUT /orchestration/dynamic-engine-environments/{environmentId}Allows to update name, description as well as particular Log and Metrics policy regarding this Dynamic Engine Environment. Doing so, you can override default policy set globally on the Dynamic Engine for logs and metrics storage location (Cloud vs Nil only for Beta)
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)
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | string Required |
Response
204Status 204
Removes a Dynamic Engine Environment
DELETE /orchestration/dynamic-engine-environments/{environmentId}Allows you to remove this environment. Be aware:
- a Dynamic Engine environment can be removed even while still connected to a Dynamic Engine
- when accepted, the removal of an environment cannot be cancelled
- promotions and their assignments defined in the environment will be removed automatically along with the environment
Prerequisites:
- User must have the Environments Manage permission, provided through the Environment Administrator role or your custom one.
- all spaces within the environment must be removed beforehand; otherwise, removal is not possible
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | string Required |
Response
204Status 204
403Status 403
409Status 409
Unassign Environment from Dynamic Engine
DELETE /orchestration/dynamic-engine-environments/{environmentId}/connectionPre-requisites :
- Environment should actually be assigned
- User should be entitled Engine Manage permission, provided through Infrastructure Administrator Role or your custom one.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | string Required |
Response
202Status 202
204Status 204
Create an assignment between this Environment and a Dynamic Engine
POST /orchestration/dynamic-engine-environments/{environmentId}/connectionPre-requisites :
- Environment should not already be assigned to any Dynamic Engine
- Dynamic Engine should already be fully connected to TMC
- User should be entitled Engine Manage permission, provided through Infrastructure Administrator Role or your custom one.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| environmentId | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| dynamicEngineId | Identifier of the Dynamic Engine cluster to assign to | string Required |
Response
202Status 202
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| Location | Connection link unique id | string Required |
204Status 204
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| Location | Connection link unique id | string Required |
409Status 409
5XXStatus 5XX
Search Dynamic Engine Environments
POST /orchestration/dynamic-engine-environments/searchSearch capacity allowing to list Dynamic Engine Environments and filter by name, status and dynamic engine. Paginated.
Pre-requisites :
- User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.