catタスク管理API

catタスク管理APIは新しいものであり、まだベータ機能と見なされるべきです。このAPIは、後方互換性のない方法で変更される可能性があります。機能のステータスについては、#51628を参照してください。

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

クラスター内で現在実行中のタスクに関する情報を返します。これは、タスク管理 APIに似ています。

リクエスト

GET /_cat/tasks

前提条件

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

説明

catタスク管理APIは、クラスター内の1つまたは複数のノードで現在実行中のタスクに関する情報を返します。これは、JSON タスク管理 APIのよりコンパクトなビューです。

クエリパラメータ

  • detailed
  • (オプション、ブール値) trueの場合、応答にはシャードの回復に関する詳細情報が含まれます。デフォルトはfalseです。
  • format
  • (オプション、文字列) HTTP Acceptヘッダーの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
  • h
  • (オプション、文字列) 表示する列名のカンマ区切りリスト。
  • help
  • (オプション、ブール値) trueの場合、応答にはヘルプ情報が含まれます。デフォルトはfalseです。
  • nodes
  • (オプション、文字列) 応答を制限するために使用されるノードIDまたは名前のカンマ区切りリスト。 ワイルドカード(*)式をサポートします。
  • parent_task_id
  • (オプション、文字列) 応答を制限するために使用される親タスクID。
  • s
  • (オプション、文字列) 応答をソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • (オプション、時間単位) 時間値を表示するために使用される単位。
  • v
  • (オプション、ブール値) trueの場合、応答には列見出しが含まれます。デフォルトはfalseです。

レスポンスコード

  • 404 (リソースが見つかりません)
  • <task_id>が指定されているが見つからない場合、このコードはリクエストに一致するリソースがないことを示します。

例

Python

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

Ruby

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

Js

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

コンソール

  1. GET _cat/tasks?v=true

APIは次の応答を返します:

コンソール-結果

  1. action                         task_id                    parent_task_id             type      start_time    timestamp running_time ip             node
  2. cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct    1458585884904 01:48:24  44.1micros   127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
  3. cluster:monitor/tasks/lists    oTUltX4IQMOUUVeiohTt8A:123 -                          transport 1458585884904 01:48:24  186.2micros  127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A