リセット変換API

変換をリセットします。

リクエスト

POST _transform/<transform_id>/_reset

前提条件

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

説明

変換をリセットする前に、それを停止する必要があります。あるいは、force クエリパラメータを使用してください。

変換をリセットすると、すべてのチェックポイント、状態、および宛先インデックス(変換によって作成された場合)は削除されます。変換は、変換の更新 API が使用されたかのように最新の形式に更新されます。変換は、まるで新たに作成されたかのように再び開始する準備が整います。

パスパラメータ

  • <transform_id>
  • (必須、文字列)変換の識別子。

クエリパラメータ

  • force
  • (オプション、ブール値)この値が true の場合、変換は現在の状態に関係なくリセットされます。false の場合、変換はリセットされる前に stopped でなければなりません。デフォルト値は false です。
  • timeout
  • (オプション、時間)応答を待つ期間。タイムアウトが切れる前に応答が受信されない場合、リクエストは失敗し、エラーが返されます。デフォルトは 30s です。

Python

  1. resp = client.transform.reset_transform(
  2. transform_id="ecommerce_transform",
  3. )
  4. print(resp)

Ruby

  1. response = client.transform.reset_transform(
  2. transform_id: 'ecommerce_transform'
  3. )
  4. puts response

Js

  1. const response = await client.transform.resetTransform({
  2. transform_id: "ecommerce_transform",
  3. });
  4. console.log(response);

コンソール

  1. POST _transform/ecommerce_transform/_reset

変換がリセットされると、次の結果が得られます:

コンソール-結果

  1. {
  2. "acknowledged" : true
  3. }