Get Task API

Introduced 1.0

The Get Task API returns detailed information about a single general OpenSearch task (such as search, reindex, or bulk operations).

This API is different from the Get ML Task API, which tracks machine learning tasks and has a different response format.

Endpoints

GET /_tasks/{task_id}

Path parameters

The following table lists the available path parameters.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

The API returns information about tasks that are currently running. After a task finishes, the API returns its information only if the task result was stored in the .tasks index. OpenSearch stores task results only for operations started using wait_for_completion=false. For a task that has finished without storing its result, the API returns an error.

Example request

To obtain a task ID, start a long-running operation, such as a reindex or update by query, using wait_for_completion=false. The following request starts a throttled reindex operation:

POST /_reindex?wait_for_completion=false&requests_per_second=50
{
  "source": {
    "index": "my-source-index"
  },
  "dest": {
    "index": "my-dest-index"
  }
}

The response contains the task ID:

{
  "task": "6It0uQ1AR06IDC4nMstPQw:1822891"
}

Alternatively, find the ID of a running task using the List Tasks API, for example, GET /_tasks?actions=*reindex.

The following request returns information about the task:

GET /_tasks/<task_id>

Example response

While the task is running, the response contains "completed": false and the current task status:

{
  "completed": false,
  "task": {
    "node": "6It0uQ1AR06IDC4nMstPQw",
    "id": 1822891,
    "type": "transport",
    "action": "indices:data/write/reindex",
    "status": {
      "total": 2000,
      "updated": 0,
      "created": 1000,
      "deleted": 0,
      "batches": 1,
      "version_conflicts": 0,
      "noops": 0,
      "retries": {
        "bulk": 0,
        "search": 0
      },
      "throttled_millis": 0,
      "requests_per_second": 50.0,
      "throttled_until_millis": 16963
    },
    "description": "reindex from [my-source-index] to [my-dest-index]",
    "start_time_in_millis": 1792185761839,
    "running_time_in_nanos": 3241833543,
    "cancellable": true,
    "cancelled": false,
    "headers": {},
    "resource_stats": {
      "average": {
        "cpu_time_in_nanos": 0,
        "memory_in_bytes": 0
      },
      "total": {
        "cpu_time_in_nanos": 0,
        "memory_in_bytes": 0
      },
      "min": {
        "cpu_time_in_nanos": 0,
        "memory_in_bytes": 0
      },
      "max": {
        "cpu_time_in_nanos": 0,
        "memory_in_bytes": 0
      },
      "thread_info": {
        "thread_executions": 0,
        "active_threads": 0
      }
    }
  }
}

After the task finishes, the response contains "completed": true and the stored result of the operation in the response object:

{
  "completed": true,
  "task": {
    "node": "6It0uQ1AR06IDC4nMstPQw",
    "id": 1822891,
    "type": "transport",
    "action": "indices:data/write/reindex",
    "status": {
      "total": 2000,
      "updated": 0,
      "created": 2000,
      "deleted": 0,
      "batches": 2,
      "version_conflicts": 0,
      "noops": 0,
      "retries": {
        "bulk": 0,
        "search": 0
      },
      "throttled_millis": 39999,
      "requests_per_second": 50.0,
      "throttled_until_millis": 0
    },
    "description": "reindex from [my-source-index] to [my-dest-index]",
    "start_time_in_millis": 1792185761839,
    "running_time_in_nanos": 40289441643,
    "cancellable": true,
    "cancelled": false,
    "headers": {}
  },
  "response": {
    "took": 40286,
    "timed_out": false,
    "total": 2000,
    "updated": 0,
    "created": 2000,
    "deleted": 0,
    "batches": 2,
    "version_conflicts": 0,
    "noops": 0,
    "retries": {
      "bulk": 0,
      "search": 0
    },
    "throttled": "39.9s",
    "throttled_millis": 39999,
    "requests_per_second": 50.0,
    "throttled_until": "0s",
    "throttled_until_millis": 0,
    "failures": []
  }
}

Response body fields

The following table lists all response body fields.

The task object

The task object contains the following fields.

The resource_stats object

The resource_stats object is only updated for tasks that support resource tracking. These statistics are computed based on scheduled thread executions, including both threads that have finished working on the task and threads currently working on the task. Because the same thread may be scheduled to work on the same task multiple times, each instance of a given thread being scheduled to work on a given task is considered to be a single thread execution.

The resource_stats object contains the following fields.

Each of the average, total, min, and max objects contains the following fields.

The thread_info object contains the following fields.

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:monitor/tasks/get.