変換の取得（Get transforms）

変換APIの取得

変換の設定情報を取得します。

リクエスト

GET _transform/<transform_id>

GET _transform/<transform_id>,<transform_id>

GET _transform/

GET _transform/_all

GET _transform/*

前提条件

monitor_transform クラスター権限が必要です。この権限は transform_user ビルトインロールに含まれています。

説明

カンマ区切りの識別子リストまたはワイルドカード式を使用して、単一のAPIリクエストで複数の変換に関する情報を取得できます。_all を使用してすべての変換に関する情報を取得するか、* を <transform_id> として指定するか、<transform_id> を省略することで情報を取得できます。

パスパラメータ

• <transform_id>
• （オプション、文字列）変換の識別子。変換識別子またはワイルドカード式である可能性があります。これらのオプションのいずれかを指定しない場合、APIはすべての変換に関する情報を返します。

クエリパラメータ

• allow_no_match
• （オプション、ブール値）リクエスト時の動作を指定します：
  • ワイルドカード式を含み、一致する変換がない場合。
  • _all 文字列を含むか、識別子がなく、一致がない場合。
  • ワイルドカード式を含み、部分一致のみがある場合。
    デフォルト値は true で、一致がない場合は空の transforms 配列を返し、部分一致がある場合は結果のサブセットを返します。
    このパラメータが false の場合、一致がないか部分一致のみの場合、リクエストは 404 ステータスコードを返します。
• exclude_generated
• （オプション、ブール値）変換作成時に自動的に追加されたフィールドを除外します。これにより、設定が取得可能な形式になり、別のクラスターに追加できます。デフォルトはfalseです。
• from
• （オプション、整数）指定された数の変換をスキップします。デフォルト値は 0 です。
• size
• （オプション、整数）取得する最大変換数を指定します。デフォルト値は 100 です。

レスポンスボディ

APIは、id 値で昇順にソートされた変換リソースの配列を返します。プロパティの完全なリストについては、変換作成APIを参照してください。

• create_time
• （文字列）変換が作成された時間。例えば、1576094542936。このプロパティは情報提供用であり、その値を変更することはできません。
• version
• （文字列）訓練されたモデルが作成されたときの変換設定バージョン番号。

Elasticsearch 8.10.0以降、変換プラグインの設定と状態の変更を追跡するために新しいバージョン番号が使用されます。この新しいバージョン番号は製品バージョンから切り離されており、独立して増加します。version 値は新しいバージョン番号を表します。

レスポンスコード

• 404 （リソースが見つかりません）
• allow_no_match が false の場合、このコードはリクエストに一致するリソースがないか、リクエストに対して部分一致のみがあることを示します。

例

以下の例は、最大10の変換に関する情報を取得します：

Python

resp = client.transform.get_transform(
   size="10",
)
print(resp)

Ruby

response = client.transform.get_transform(
  size: 10
)
puts response

Js

const response = await client.transform.getTransform({
  size: 10,
});
console.log(response);

コンソール

GET _transform?size=10

以下の例は、ecommerce_transform1 変換の設定情報を取得します：

Python

resp = client.transform.get_transform(
   transform_id="ecommerce_transform1",
)
print(resp)

Ruby

response = client.transform.get_transform(
  transform_id: 'ecommerce_transform1'
)
puts response

Js

const response = await client.transform.getTransform({
  transform_id: "ecommerce_transform1",
});
console.log(response);

コンソール

GET _transform/ecommerce_transform1

APIは以下の結果を返します：

コンソール-結果

{
  "count" : 1,
  "transforms" : [
   {
   "id" : "ecommerce_transform1",
   "authorization" : {
   "roles" : [
   "superuser"
   ]
   },
   "version" : "8.4.0",
   "create_time" : 1656023416565,
   "source" : {
   "index" : [
   "kibana_sample_data_ecommerce"
   ],
   "query" : {
   "term" : {
   "geoip.continent_name" : {
   "value" : "Asia"
   }
   }
   }
   },
   "dest" : {
   "index" : "kibana_sample_data_ecommerce_transform1",
   "pipeline" : "add_timestamp_pipeline"
   },
   "frequency" : "5m",
   "sync" : {
   "time" : {
   "field" : "order_date",
   "delay" : "60s"
   }
   },
   "pivot" : {
   "group_by" : {
   "customer_id" : {
   "terms" : {
   "field" : "customer_id"
   }
   }
   },
   "aggregations" : {
   "max_price" : {
   "max" : {
   "field" : "taxful_total_price"
   }
   }
   }
   },
   "description" : "Maximum priced ecommerce data by customer_id in Asia",
   "settings" : { },
   "retention_policy" : {
   "time" : {
   "field" : "order_date",
   "max_age" : "30d"
   }
   }
   }
  ]
}