EtlApi

Method	HTTP request	Description
healthETL	GET /v1/etl/{etl-name}/health	Get health status of ETL job
httpetldel	DELETE /v1/etl/{etl-name}	Delete and remove an ETL job by name
httpetlpost	POST /v1/etl/{etl-name}/start	Start or stop ETL jobs by name
httpetlpostpoststop	POST /v1/etl/{etl-name}/stop	Start or stop ETL jobs by name
httpetlput	PUT /v1/etl	Create and initialize a new ETL job to transform data during transfers.
infoETL	GET /v1/etl/{etl-name}	Get detailed information about a specific ETL job
listETL	GET /v1/etl	List all ETL jobs in the cluster
logsETL	GET /v1/etl/{etl-name}/logs	Get logs from ETL job execution
logsETLgetlogs	GET /v1/etl/{etl-name}/logs/{target-id}	Get logs from ETL job execution
metricsETL	GET /v1/etl/{etl-name}/metrics	Get CPU and memory metrics for ETL job

healthETL

Object healthETL()

Get health status of ETL job

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl/{etl-name}/health'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

httpetldel

Object httpetldel()

Delete and remove an ETL job by name

Example: Delete etl

curl -i -L -X DELETE \
  'AIS_ENDPOINT/v1/etl/{etl-name}'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

httpetlpost

Object httpetlpost()

Start or stop ETL jobs by name

Example: Post etl

curl -i -L -X POST \
  'AIS_ENDPOINT/v1/etl/{etl-name}/start'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

httpetlpostpoststop

Object httpetlpostpoststop()

Start or stop ETL jobs by name

Example: Post etl

curl -i -L -X POST \
  'AIS_ENDPOINT/v1/etl/{etl-name}/stop'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

httpetlput

Object httpetlput(request)

Create and initialize a new ETL job to transform data during transfers.

Request model: ETLSpecMsg, InitSpecMsg

Example: Put etl

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"name": "echo-etl", "communication": "hpush://", "runtime": {"image": "aistorage/transformer_echo:latest"}}' \
  'AIS_ENDPOINT/v1/etl'

Example: Put etl

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"name": "my-etl", "communication": "hpush://", "spec": "<base64-encoded-kubernetes-pod-spec>"}' \
  'AIS_ENDPOINT/v1/etl'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

infoETL

Object infoETL()

Get detailed information about a specific ETL job

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl/{etl-name}'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

listETL

Object listETL()

List all ETL jobs in the cluster

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

logsETL

Object logsETL()

Get logs from ETL job execution

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl/{etl-name}/logs'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

logsETLgetlogs

Object logsETLgetlogs()

Get logs from ETL job execution

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl/{etl-name}/logs/{target-id}'

Parameters

Return type

Object

HTTP request headers

Content-Type: Not defined
Accept: /

metricsETL

Object metricsETL()

Get CPU and memory metrics for ETL job

Example: Get etl

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/etl/{etl-name}/metrics'