Orchestrations HTTP API syntax

Question

I'm trying to obtain the runtime status of all my Orchestrations, and any that are either Failed or Null take some action. We've noticed that after a deployment, some of these orchestrations get stuck in a weird state after a deploy and don't run until we update the RuntimeStatus in the table of the functions app directly.

I have attempted to hit this url:
<functionappurl>/runtime/webhooks/durableTask/instances?top=10 with the <functionappurl> being the URL shown in Azure, but it doesn't seem to return anything. Am I using the request wrong, or is there some other thing I should be looking at to get data back about my functions app.

Answer 1

Hello @Kasey Clark

It seems like you are on the right track. The URL you are using is correct for retrieving the status of all your orchestrations.

However, you may need to add some query parameters to filter the results and get the specific information you need. For example, you can add the runtimeStatus query parameter to filter by the runtime status of the orchestrations. To retrieve orchestrations that are either Failed or Null, you can use the following URL: /runtime/webhooks/durabletask/instances?top=10&runtimeStatus=Failed,Null

This will return the top 10 orchestrations that have a runtime status of either Failed or Null. You can adjust the top parameter to retrieve more or fewer orchestrations as needed.

If you are still not getting any results, it's possible that there are no orchestrations that match your filter criteria. You can try removing the runtimeStatus parameter to retrieve all orchestrations and see if any are returned. If you are still having trouble, you may want to check the logs for your function app to see if there are any errors or issues that could be preventing the orchestrations from running.

---

I hope that this response has addressed your query and helped you overcome your challenges. If so, please mark this response as Answered. This will not only acknowledge our efforts, but also assist other community members who may be looking for similar solutions.