You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@seatunnel.apache.org by "Arshad, Mohammad" <mo...@visa.com.INVALID> on 2024/08/12 11:01:54 UTC
Regarding Seatunnel-web REST API usage
Hi All
I am exploring to integrate seatunnel-web with our existing pipeline system.
This pipeline system will interact with seatunnel-web through REST API.
I have few questions, can you please help me with the answers, if you know?
1. The current REST APIs for seatunnel-web are designed with a focus on consumption from the web UI.
For example to create a job we need to invoke following four APIs.
POST seatunnel/api/v1/job/definition
POST seatunnel/api/v1/job/task/{jobVersionId} as many times as the number of steps in job
PUT seatunnel/api/v1/job/config/{jobVersionId}
POST seatunnel/api/v1/job/dag/{jobVersionId}
is there any API to create a job in single API call?
2. There is no API available to execute a job with parameters.
3. None of the APIs returning the cause of the job failure. It will be unknown to user why the job failed.
is there something planned to add these features in future?
is there something already available which I am missing?
Thanks & Regards
Mohammad Arshad
Re: Regarding Seatunnel-web REST API usage
Posted by Jia Fan <fa...@gmail.com>.
> Interacting with both Seatunnel and Seatunnel-web may not be an optimal
design choice.
> Instead, we should consider enhancing Seatunnel-web to fulfill the these
requirements.
Yes. I agree with you.
Arshad, Mohammad <mo...@visa.com.invalid> 于2024年8月13日周二 01:14写道：
> Thanks Jia Fan for your quick response.
>
> Interacting with both Seatunnel and Seatunnel-web may not be an optimal
> design choice.
> Instead, we should consider enhancing Seatunnel-web to fulfill the these
> requirements.
>
> Thanks & Regards
> Mohammad Arshad
>
>
> From: Jia Fan <fa...@gmail.com>
> Date: Monday, 12 August 2024 at 5:03 PM
> To: dev@seatunnel.apache.org <de...@seatunnel.apache.org>
> Subject: Re: Regarding Seatunnel-web REST API usage
> Quick answer:
> 1. No. Currently can do this through web api. But we have rest api in
> seatunnel. You can refer
>
> https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fseatunnel.apache.org%2Fdocs%2F2.3.6%2Fseatunnel-engine%2Frest-api&data=05%7C02%7Cmohammad.arshad%40visa.com%7C73ccfc9fb7424cdd831108dcbac287f8%7C38305e12e15d4ee888b9c4db1c477d76%7C0%7C0%7C638590591876188858%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=hGpXx%2FRSm2971uEjHxcB%2B4ACzr%2BXW%2FkRSwDx%2B4sdn94%3D&reserved=0
> <https://seatunnel.apache.org/docs/2.3.6/seatunnel-engine/rest-api>
> 2. No. We need develop this feature.
> 3. We can use rest api which mentioned in 1.
>
> > is there something planned to add these features in future?
> Yes. These requirements are all features that the web needs, and we need to
> iterate and support them.
>
> BTW. Thanks Mohammad for your work on web.
>
>
>
>
>
> Arshad, Mohammad <mo...@visa.com.invalid> 于2024年8月12日周一 19:02写道：
>
> > Hi All
> > I am exploring to integrate seatunnel-web with our existing pipeline
> > system.
> > This pipeline system will interact with seatunnel-web through REST API.
> > I have few questions, can you please help me with the answers, if you
> know?
> >
> > 1. The current REST APIs for seatunnel-web are designed with a focus on
> > consumption from the web UI.
> > For example to create a job we need to invoke following four APIs.
> > POST seatunnel/api/v1/job/definition
> > POST seatunnel/api/v1/job/task/{jobVersionId} as many times as the number
> > of steps in job
> > PUT seatunnel/api/v1/job/config/{jobVersionId}
> > POST seatunnel/api/v1/job/dag/{jobVersionId}
> >
> > is there any API to create a job in single API call?
> >
> > 2. There is no API available to execute a job with parameters.
> > 3. None of the APIs returning the cause of the job failure. It will be
> > unknown to user why the job failed.
> >
> > is there something planned to add these features in future?
> > is there something already available which I am missing?
> >
> > Thanks & Regards
> > Mohammad Arshad
> >
> >
>
Re: Regarding Seatunnel-web REST API usage
Posted by "Arshad, Mohammad" <mo...@visa.com.INVALID>.
Thanks Jia Fan for your quick response.
Interacting with both Seatunnel and Seatunnel-web may not be an optimal design choice.
Instead, we should consider enhancing Seatunnel-web to fulfill the these requirements.
Thanks & Regards
Mohammad Arshad
From: Jia Fan <fa...@gmail.com>
Date: Monday, 12 August 2024 at 5:03 PM
To: dev@seatunnel.apache.org <de...@seatunnel.apache.org>
Subject: Re: Regarding Seatunnel-web REST API usage
Quick answer:
1. No. Currently can do this through web api. But we have rest api in
seatunnel. You can refer
https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fseatunnel.apache.org%2Fdocs%2F2.3.6%2Fseatunnel-engine%2Frest-api&data=05%7C02%7Cmohammad.arshad%40visa.com%7C73ccfc9fb7424cdd831108dcbac287f8%7C38305e12e15d4ee888b9c4db1c477d76%7C0%7C0%7C638590591876188858%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=hGpXx%2FRSm2971uEjHxcB%2B4ACzr%2BXW%2FkRSwDx%2B4sdn94%3D&reserved=0<https://seatunnel.apache.org/docs/2.3.6/seatunnel-engine/rest-api>
2. No. We need develop this feature.
3. We can use rest api which mentioned in 1.
> is there something planned to add these features in future?
Yes. These requirements are all features that the web needs, and we need to
iterate and support them.
BTW. Thanks Mohammad for your work on web.
Arshad, Mohammad <mo...@visa.com.invalid> 于2024年8月12日周一 19:02写道：
> Hi All
> I am exploring to integrate seatunnel-web with our existing pipeline
> system.
> This pipeline system will interact with seatunnel-web through REST API.
> I have few questions, can you please help me with the answers, if you know?
>
> 1. The current REST APIs for seatunnel-web are designed with a focus on
> consumption from the web UI.
> For example to create a job we need to invoke following four APIs.
> POST seatunnel/api/v1/job/definition
> POST seatunnel/api/v1/job/task/{jobVersionId} as many times as the number
> of steps in job
> PUT seatunnel/api/v1/job/config/{jobVersionId}
> POST seatunnel/api/v1/job/dag/{jobVersionId}
>
> is there any API to create a job in single API call?
>
> 2. There is no API available to execute a job with parameters.
> 3. None of the APIs returning the cause of the job failure. It will be
> unknown to user why the job failed.
>
> is there something planned to add these features in future?
> is there something already available which I am missing?
>
> Thanks & Regards
> Mohammad Arshad
>
>
Re: Regarding Seatunnel-web REST API usage
Posted by Jia Fan <fa...@gmail.com>.
Quick answer:
1. No. Currently can do this through web api. But we have rest api in
seatunnel. You can refer
https://seatunnel.apache.org/docs/2.3.6/seatunnel-engine/rest-api
2. No. We need develop this feature.
3. We can use rest api which mentioned in 1.
> is there something planned to add these features in future?
Yes. These requirements are all features that the web needs, and we need to
iterate and support them.
BTW. Thanks Mohammad for your work on web.
Arshad, Mohammad <mo...@visa.com.invalid> 于2024年8月12日周一 19:02写道：
> Hi All
> I am exploring to integrate seatunnel-web with our existing pipeline
> system.
> This pipeline system will interact with seatunnel-web through REST API.
> I have few questions, can you please help me with the answers, if you know?
>
> 1. The current REST APIs for seatunnel-web are designed with a focus on
> consumption from the web UI.
> For example to create a job we need to invoke following four APIs.
> POST seatunnel/api/v1/job/definition
> POST seatunnel/api/v1/job/task/{jobVersionId} as many times as the number
> of steps in job
> PUT seatunnel/api/v1/job/config/{jobVersionId}
> POST seatunnel/api/v1/job/dag/{jobVersionId}
>
> is there any API to create a job in single API call?
>
> 2. There is no API available to execute a job with parameters.
> 3. None of the APIs returning the cause of the job failure. It will be
> unknown to user why the job failed.
>
> is there something planned to add these features in future?
> is there something already available which I am missing?
>
> Thanks & Regards
> Mohammad Arshad
>
>