パイプライン削除API
既存のインジェストパイプラインを1つ以上削除します。
Python
resp = client.ingest.delete_pipeline(
id="my-pipeline-id",
)
print(resp)
Ruby
response = client.ingest.delete_pipeline(
id: 'my-pipeline-id'
)
puts response
Js
const response = await client.ingest.deletePipeline({
id: "my-pipeline-id",
});
console.log(response);
コンソール
DELETE /_ingest/pipeline/my-pipeline-id
リクエスト
DELETE /_ingest/pipeline/<pipeline>
前提条件
- Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには、
manage_pipeline
、manage_ingest_pipelines
、またはmanage
クラスター権限が必要です。
パスパラメータ
<pipeline>
- (必須、文字列) リクエストを制限するために使用されるパイプラインIDまたはパイプラインIDのワイルドカード式。
クラスター内のすべてのインジェストパイプラインを削除するには、*
の値を使用します。
クエリパラメータ
master_timeout
- (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは
30s
です。リクエストがタイムアウトしないことを示すために-1
に設定することもできます。 timeout
- (オプション、時間単位) クラスターのメタデータを更新した後、クラスター内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスターのメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは
30s
です。リクエストがタイムアウトしないことを示すために-1
に設定することもできます。
例
特定のインジェストパイプラインを削除
Python
resp = client.ingest.delete_pipeline(
id="pipeline-one",
)
print(resp)
Ruby
response = client.ingest.delete_pipeline(
id: 'pipeline-one'
)
puts response
Js
const response = await client.ingest.deletePipeline({
id: "pipeline-one",
});
console.log(response);
コンソール
DELETE /_ingest/pipeline/pipeline-one
ワイルドカード式を使用してインジェストパイプラインを削除
Python
resp = client.ingest.delete_pipeline(
id="pipeline-*",
)
print(resp)
Ruby
response = client.ingest.delete_pipeline(
id: 'pipeline-*'
)
puts response
Js
const response = await client.ingest.deletePipeline({
id: "pipeline-*",
});
console.log(response);
コンソール
DELETE /_ingest/pipeline/pipeline-*
すべてのインジェストパイプラインを削除
Python
resp = client.ingest.delete_pipeline(
id="*",
)
print(resp)
Ruby
response = client.ingest.delete_pipeline(
id: '*'
)
puts response
Js
const response = await client.ingest.deletePipeline({
id: "*",
});
console.log(response);
コンソール
DELETE /_ingest/pipeline/*