Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Tasks → Cancel Tasks

AI-generated

Overview

This node operation cancels tasks in Meilisearch based on specified filtering criteria. It allows users to cancel tasks by providing various filters such as UIDs, Index UIDs, statuses, types, who canceled the task, and time-based filters for when tasks were enqueued, started, or finished. This is useful for managing and controlling task execution in Meilisearch, especially when needing to stop certain tasks programmatically.

Use Case Examples

  1. Cancel tasks by specifying their UIDs to stop specific tasks.
  2. Cancel tasks filtered by their status or type to manage task workflow.
  3. Cancel tasks that were enqueued or started before or after certain dates to control task execution timing.

Properties

Name Meaning
UIDs Comma delimited list of UID(s) to filter results by, used to specify which tasks to cancel.
Index UIDs Comma delimited list of Index UID(s) to filter results by, to target tasks related to specific indexes.
Statuses Comma delimited list of Task Status(es) to filter results by, to cancel tasks with specific statuses.
Types Comma delimited list of Task Type(s) to filter results by, to cancel tasks of certain types.
Canceled By Comma delimited list of Task UID(s) that canceled another task(s), to filter tasks canceled by specific tasks.
Before Enqueued At Filter tasks based on their enqueuedAt time before the specified date/time.
After Enqueued At Filter tasks based on their enqueuedAt time after the specified date/time.
Before Started At Filter tasks based on their startedAt time before the specified date/time.
After Started At Filter tasks based on their startedAt time after the specified date/time.
Before Finished At Filter tasks based on their finishedAt time before the specified date/time.
After Finished At Filter tasks based on their finishedAt time after the specified date/time.

Output

JSON

  • json - The response from Meilisearch API after attempting to cancel tasks, including task status and details.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • Ensure the Meilisearch API credentials are correctly configured and have permissions to cancel tasks.
  • Verify that the UIDs or other filter parameters are correctly formatted and valid to avoid empty or incorrect cancellations.
  • If the node times out waiting for task completion, increase the timeout or check the Meilisearch server status.

Links

Discussion