コネクタのリスト API

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

作成されたすべてのコネクタに関する情報を返します。

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

リクエスト

GET _connector

前提条件

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

パスパラメータ

  • size
  • (オプション、整数)取得する結果の最大数。デフォルトは 100 です。
  • from
  • (オプション、整数)最初の結果から取得するオフセット。デフォルトは 0 です。
  • index_name
  • (オプション、文字列)コネクタに関連付けられたインデックス名のカンマ区切りリストで、検索結果をフィルタリングするために使用されます。
  • connector_name
  • (オプション、文字列)検索結果をフィルタリングするために使用されるコネクタ名のカンマ区切りリスト。
  • service_type
  • (オプション、文字列)検索結果をフィルタリングするために使用されるコネクタサービスの種類のカンマ区切りリスト。

次の例は、すべてのコネクタをリストします:

Python

  1. resp = client.connector.list()
  2. print(resp)

Ruby

  1. response = client.connector.list
  2. puts response

Js

  1. const response = await client.connector.list();
  2. console.log(response);

コンソール

  1. GET _connector

次の例は、最初の 2 つのコネクタをリストします:

Python

  1. resp = client.connector.list(
  2. from_="0",
  3. size="2",
  4. )
  5. print(resp)

Js

  1. const response = await client.connector.list({
  2. from: 0,
  3. size: 2,
  4. });
  5. console.log(response);

コンソール

  1. GET _connector?from=0&size=2

search-google-drive Elasticsearch インデックスに関連付けられたコネクタをリストする例:

Python

  1. resp = client.connector.list(
  2. index_name="search-google-drive",
  3. )
  4. print(resp)

Js

  1. const response = await client.connector.list({
  2. index_name: "search-google-drive",
  3. });
  4. console.log(response);

コンソール

  1. GET _connector?index_name=search-google-drive

sharepoint_online サービスタイプのすべてのコネクタをリストする例:

Python

  1. resp = client.connector.list(
  2. service_type="sharepoint_online",
  3. )
  4. print(resp)

Js

  1. const response = await client.connector.list({
  2. service_type: "sharepoint_online",
  3. });
  4. console.log(response);

コンソール

  1. GET _connector?service_type=sharepoint_online

sharepoint_online または google_drive サービスタイプのすべてのコネクタをリストする例:

Python

  1. resp = client.connector.list(
  2. service_type="sharepoint_online,google_drive",
  3. )
  4. print(resp)

Js

  1. const response = await client.connector.list({
  2. service_type: "sharepoint_online,google_drive",
  3. });
  4. console.log(response);

コンソール

  1. GET _connector?service_type=sharepoint_online,google_drive