cat pending tasks API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、pending cluster tasks APIを使用してください。

実行されていないクラスターレベルの変更を返します。これは、pending cluster tasks APIに似ています。

Request

GET /_cat/pending_tasks

Prerequisites

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage cluster privilegeが必要です。

Query parameters

  • format
  • (オプション、文字列) HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
  • h
  • (オプション、文字列) 表示する列名のカンマ区切りリスト。
  • help
  • (オプション、Boolean) trueの場合、レスポンスにはヘルプ情報が含まれます。 デフォルトはfalseです。
  • local
  • (オプション、Boolean) trueの場合、リクエストはローカルノードからのみ情報を取得します。 デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
  • master_timeout
  • (オプション、time units) マスターノードを待機する期間。 タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。 デフォルトは30sです。 リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • s
  • (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • (オプション、time units) 時間値を表示するために使用される単位。
  • v
  • (オプション、Boolean) trueの場合、レスポンスには列見出しが含まれます。 デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.pending_tasks(
  2. v=True,
  3. )
  4. print(resp)

Ruby

  1. response = client.cat.pending_tasks(
  2. v: true
  3. )
  4. puts response

Js

  1. const response = await client.cat.pendingTasks({
  2. v: "true",
  3. });
  4. console.log(response);

Console

  1. GET /_cat/pending_tasks?v=true

APIは次のレスポンスを返します:

Txt

  1. insertOrder timeInQueue priority source
  2. 1685 855ms HIGH update-mapping [foo][t]
  3. 1686 843ms HIGH update-mapping [foo][t]
  4. 1693 753ms HIGH refresh-mapping [foo][[t]]
  5. 1688 816ms HIGH update-mapping [foo][t]
  6. 1689 802ms HIGH update-mapping [foo][t]
  7. 1690 787ms HIGH update-mapping [foo][t]
  8. 1691 773ms HIGH update-mapping [foo][t]