コネクタの作成（Create connector）

コネクタAPIの作成

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

Elasticコネクタを作成します。コネクタは、Elastic Cloud上で展開するか、独自のインフラストラクチャでホストできるサードパーティデータソースからコンテンツを取り込むElasticsearch統合です：

• ネイティブコネクタはElastic Cloud上の管理サービスです
• コネクタクライアントは独自のインフラストラクチャ上で自己管理されます

すべてのサポートされているサービスタイプのリストは、コネクタのドキュメントで確認できます。

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

Python

resp = client.connector.put(
   connector_id="my-connector",
   index_name="search-google-drive",
   name="My Connector",
   service_type="google_drive",
)
print(resp)

Ruby

response = client.connector.put(
  connector_id: 'my-connector',
  body: {
   index_name: 'search-google-drive',
   name: 'My Connector',
   service_type: 'google_drive'
  }
)
puts response

Js

const response = await client.connector.put({
  connector_id: "my-connector",
  index_name: "search-google-drive",
  name: "My Connector",
  service_type: "google_drive",
});
console.log(response);

コンソール

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}

リクエスト

• POST _connector
• PUT _connector/<connector_id>

前提条件

• 自己管理コネクタを使用してデータを同期するには、独自のインフラストラクチャ上にElasticコネクタサービスを展開する必要があります。このサービスは、ネイティブコネクタの場合、Elastic Cloud上で自動的に実行されます。
• service_typeパラメータは、サポートされているサードパーティサービスを参照する必要があります。ネイティブおよび自己管理コネクタの利用可能なサービスタイプを参照してください。これは、カスタムコネクタのサービスタイプを参照することもできます。

説明

内部インデックスにコネクタドキュメントを作成し、その構成、フィルタリング、およびスケジューリングをデフォルト値で初期化します。これらの値は、必要に応じて後で更新できます。

パスパラメータ

• <connector_id>
• （オプション、文字列）コネクタの一意の識別子。

リクエストボディ

• description
• （オプション、文字列）コネクタの説明。
• index_name
• （オプション、文字列）データを同期するターゲットインデックス。インデックスが存在しない場合、最初の同期時に作成されます。
• name
• （オプション、文字列）コネクタの名前。Kibanaでコネクタを管理する際にコネクタ名を設定することをお勧めします。
• is_native
• （オプション、ブール値）ネイティブコネクタであるかどうかを示します。デフォルトはfalseです。
• language
• （オプション、文字列）データの言語アナライザー。サポートされている言語に制限されます。
• service_type
• （オプション、文字列）コネクタサービスのタイプ。Elasticがサポートするサードパーティサービスまたはカスタムコネクタタイプを参照できます。ネイティブおよび自己管理コネクタの利用可能なサービスタイプを参照してください。

レスポンスボディ

• id
• （文字列）コネクタドキュメントに関連付けられたID。POSTリクエストを使用したときに返されます。
• result
• （文字列）インデックス操作の結果、createdまたはupdated。PUTリクエストを使用したときに返されます。

レスポンスコード

• 200
• 既存のコネクタが正常に更新されたことを示します。
• 201
• コネクタが正常に作成されたことを示します。
• 400
• リクエストが不正であることを示します。

例

Python

resp = client.connector.put(
   connector_id="my-connector",
   index_name="search-google-drive",
   name="My Connector",
   description="My Connector to sync data to Elastic index from Google Drive",
   service_type="google_drive",
   language="english",
)
print(resp)

Ruby

response = client.connector.put(
  connector_id: 'my-connector',
  body: {
   index_name: 'search-google-drive',
   name: 'My Connector',
   description: 'My Connector to sync data to Elastic index from Google Drive',
   service_type: 'google_drive',
   language: 'english'
  }
)
puts response

Js

const response = await client.connector.put({
  connector_id: "my-connector",
  index_name: "search-google-drive",
  name: "My Connector",
  description: "My Connector to sync data to Elastic index from Google Drive",
  service_type: "google_drive",
  language: "english",
});
console.log(response);

コンソール

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "description": "My Connector to sync data to Elastic index from Google Drive",
  "service_type": "google_drive",
  "language": "english"
}

APIは次の結果を返します：

コンソール-結果

{
  "result": "created",
  "id": "my-connector"
}