コネクタ削除API

この機能はベータ版であり、変更される可能性があります。設計とコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

コネクタと関連する同期ジョブを削除します。これは復元不可能な破壊的なアクションです。

注意：このアクションは、コネクタに関連するAPIキー、インジェストパイプライン、またはデータインデックスを削除しません。これらは手動で削除する必要があります。

コネクタAPIを始めるには、チュートリアルを確認してください。

リクエスト

DELETE _connector/<connector_id>

前提条件

  • 自己管理のコネクタを使用してデータを同期するには、独自のインフラストラクチャにElasticコネクタサービスをデプロイする必要があります。このサービスは、ネイティブコネクタ用にElastic Cloud上で自動的に実行されます。
  • connector_idパラメータは、既存のコネクタを参照する必要があります。

パスパラメータ

  • <connector_id>
  • (必須、文字列)
  • delete_sync_jobs
  • (オプション、ブール値) 関連する同期ジョブも削除するかどうかを示すフラグ。デフォルトはfalseです。

レスポンスコード

  • 400
  • connector_idが提供されていません。
  • 404 (リソースが不足しています)
  • connector_idに一致するコネクタが見つかりませんでした。

例

次の例は、IDがmy-connectorのコネクタを削除します:

Python

  1. resp = client.connector.delete(
  2.    connector_id="another-connector",
  3.    delete_sync_jobs=True,
  4. )
  5. print(resp)

Js

  1. const response = await client.connector.delete({
  2.   connector_id: "another-connector",
  3.   delete_sync_jobs: "true",
  4. });
  5. console.log(response);

コンソール

  1. DELETE _connector/another-connector?delete_sync_jobs=true

コンソール-結果

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

次の例は、IDがanother-connectorのコネクタとその関連する同期ジョブを削除します。