Recently Azure Data Factory & Azure Synapse made API response timeout improvement in Web Activity by introducing a response timeout property ‘Http Request Timeout‘ in Web activity to provide larger timeouts for synchronous APIs.
Web activity is used to invoke an external API endpoint from within an ADF/Synapse pipeline.
It works well with async or asynchronous APIs that follow the asynchronous request-reply pattern i.e. asynchronous calls do not block (or wait) the current execution for the API call to return from the server.
Steps to navigate to Web Activity & new property HTTP Request Timeout:
Open the web activity of Azure Synapse and click on settings tab and find the ‘HTTP request timeout’ property as shown below:
WHY we need this? What challenges this new property address?
It resolve timeout issue in case of sync API call.
Details: When we use sync/synchronous API endpoints where ADF pipeline or synapse pipeline has to wait or halt the current execution until it gets response from API endpoint.
” As default action, the web activity will timeout within 1 minute if it does not receive any response.”
Web Activity in Azure Data Factory Pipeline: HTTP Request Timeout property –
HOW to resolve this issue?
It has made API response timeout improvement in Web Activity by introducing a response timeout property ‘HttpRequestTimeout’ in Web activity to provide larger timeouts for synchronous APIs.
HTTP Request Timeout of Web Activity as explained by Microsoft on how to use this property:
” Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes “
Web Activity in Azure Synapse Pipeline: HTTP Request Timeout property –
Hope now we understood why we need this new property and how we can use this in our project.
Thanks for reading this article; Please feel free to comment below in case of any query/suggestion.