Data Plane Environments

Manage and connect Environments to your Data Planes.

Media type

application/json

Endpoints

Global security

These security schemes apply to the entire API

  • No authentication

Create new Data Plane Environment

POST /orchestration/dataplane-environments

A Data Plane Environment is an Environment that can be connected to one DataPlane.

While keeping all existing capability available on Environments, it also brings DataPlane targeted executions : once connected, all executions of any task or plan defined within this Environment will occur on the connected DataPlane. Please consult Connection sub-resource to learn more about DataPlane 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)

Request

Body
application/json
CreateDataPlaneEnvironmentRequest

Response

201Status 201
Body
application/json
DPEnvironment
400Status 400
Incorrect request
Body
application/json
ErrorResponse
401Status 401
Body
application/json
ErrorResponse
403Status 403
Not authorized to create the environment
409Status 409
Environment name should be unique
500Status 500

Update one Data Plane Environment

PUT /orchestration/dataplane-environments/{environmentId}

Allows to update name, description as well as particular Log and Metrics policy regarding this Data Plane Environment. Doing so, you can override default policy set globally on the Data Plane 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

Path variables
Name Description Type Attributes and examples
environmentId Id of the Environment string Required
Body
application/json
UpdateDataPlaneEnvironmentRequest

Response

200Status 200
Body
application/json
DPEnvironment
400Status 400
Body
application/json
ErrorResponse
401Status 401
Body
application/json
ErrorResponse
403Status 403
Body
application/json
ErrorResponse
404Status 404
Body
application/json
ErrorResponse
500Status 500
Body
application/json
ErrorResponse

Retrieves a Data Plane Environment

GET /orchestration/dataplane-environments/{environmentId}

Pre-requisites :

  • User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.

Request

Path variables
Name Description Type Attributes and examples
environmentId Id of the Environment string Required

Response

200Status 200
Body
application/json
DPEnvironment
400Status 400
Body
application/json
ErrorResponse
401Status 401
Body
application/json
ErrorResponse
403Status 403
Body
application/json
ErrorResponse
404Status 404
Body
application/json
ErrorResponse
500Status 500
Body
application/json
ErrorResponse

Removes a Data Plane Environment

DELETE /orchestration/dataplane-environments/{environmentId}

Allows to remove this Environment. Please be aware :

  • when connected, a DataPlane Environment wont be removed
  • when accepted the removal of an Environment cant be cancelled
  • all subsidiary elements within the Environment (tasks, plans, workspaces, etc.) will be removed along with the removal of the Environment itself

Pre-requisites :

  • User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.

Request

Path variables
Name Description Type Attributes and examples
environmentId Id of the Environment string Required

Response

204Status 204
DP Environment successfully removed
400Status 400
Incorrect request
Body
application/json
ErrorResponse
401Status 401
Body
application/json
ErrorResponse
403Status 403
User doesn’t have sufficient permissions to complete a request
Body
application/json
ErrorResponse
409Status 409
DP Environment has an established connection to Data Plane, disconnection is required prior to removal
Body
application/json
ErrorResponse
500Status 500
Internal server error
Body
application/json
ErrorResponse

Create a connection between this Environment and some Data Plane cluster.

POST /orchestration/dataplane-environments/{environmentId}/connection

Pre-requisites :

  • Environment should not already be connected to one Data Plane
  • Environment should not be in disconnecting state
  • Data Plane should already be fully connected to TMC
  • User should be entitled Engine Manage permission, provided through Infrastructure Administrator Role or your custom one.

Request

Path variables
Name Description Type Attributes and examples
environmentId string Required
Query parameters
Name Description Type Attributes and examples
dataplaneId Identifier of the Data Plane cluster to connect to string Required

Response

202Status 202
Environment connection to the data plane is processing
204Status 204
Environment is already connected to this data plane
400Status 400
401Status 401
403Status 403
409Status 409
The environment is already connected to some different DataPlane
503Status 503
The data plane is not ready for connection
5XXStatus 5XX
Namespace allocation is not possible / timeout on comm with DP / etc

Disconnect Environment from Data Plane cluster

DELETE /orchestration/dataplane-environments/{environmentId}/connection

Pre-requisites :

  • Environment should actually be connected
  • User should be entitled Engine Manage permission, provided through Infrastructure Administrator Role or your custom one.

Request

Path variables
Name Description Type Attributes and examples
environmentId string Required

Response

202Status 202
Unconnected accepted
204Status 204
Environment is already unconnected
400Status 400
401Status 401
403Status 403
500Status 500

Search Data Plane Environments

POST /orchestration/dataplane-environments/search

Search capacity allowing to list DataPlane Environments and filter by name, status and dataplane. Paginated.

Pre-requisites :

  • User should be entitled Environments Manage permission, provided through Environment Administrator Role or your custom one.

Request

Body
application/json
SearchDataPlaneEnvironmentsRequest

Response

200Status 200
Body
application/json
DPEnvironmentPage

DPEnvironment

A Data Plane Environment is an Environment that can be connected to one DataPlane.

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

Object
Name Description Type Attributes and examples
id Unique identifier string Required
name Unique name string Required
description Description string Required
dpId Identifier of the DataPlane this Environment might be connected to string Optional
status

Connection status between Environment and Data Plane. Possible statuses are the following :

Not Connected : Environment can be used for any Orchestration/configuration action : add workspace, etc. Connecting : Transitional state. Some DP link is configured but Processing is not yet possible. Connected : DataPlane ressources for the Environment have been installed successfully. Processing is fully available. Disconnecting : Transitional state. DP link is still configured. Re-connecting is not yet possible and processing no longer available. In Error : Error state. DP link is configured but some error occured on Data Plane. Please check with you Infra Admin.

 string Required
Enum
  • NOT_CONNECTED
  • CONNECTING
  • CONNECTED
  • DISCONNECTING
  • IN_ERROR
logStrategy Dataplane Strategy on logs regarding this Environment’s executions string Required
Enum
  • NONE
  • CONTROL_PLANE
metricsStrategy Dataplane Strategy on metrics regarding this Environment’s executions string Required
Enum
  • NONE
  • CONTROL_PLANE
createdBy Username of user who created Data Plane Environment string Optional
Example
admin
creationDate Creation Date of Data Plane Environment datetime Optional
Example
"2023-10-24T10:49:00.658Z"
lastModifiedBy Username of user who last updated Data Plane 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 Data Plane Environment, either HUMAN or SERVICE_ACCOUNT string Optional
Example
SERVICE_ACCOUNT
modifierType Type of user who last modified Data Plane Environment, either HUMAN or SERVICE_ACCOUNT string Optional
Example
HUMAN

ErrorResponse

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

CreateDataPlaneEnvironmentRequest

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

SearchDataPlaneEnvironmentsRequest

Object
Name Description Type Attributes and examples
name like filter on name string Optional
dpId Dataplane identifier string Optional
limit integer Optional
FormatINT32
offset integer Optional
FormatINT32
sortOrder sort order of fetched data plane environments string Optional
DefaultDESC
Examples
  • DESC
  • ASC
sortBy attribute data plane environments are sorted by, sorted by creation time by default string Optional
Examples
  • "status"
  • "name"

UpdateDataPlaneEnvironmentRequest

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

DPEnvironmentPage

Object
Name Description Type Attributes and examples
data array of DPEnvironment Optional
Datatype details
Type Description Attributes and examples
array
DPEnvironment
limit integer Optional
offset integer Optional
totalLength integer Optional
back to top↑