コネクタ設定の更新（Update connector configuration）

コネクタ構成APIの更新

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

コネクタのconfigurationを更新し、登録された構成スキーマ内での構成値の更新を可能にします。

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

リクエスト

PUT _connector/<connector_id>/_configuration

前提条件

• 自己管理型コネクタを使用してデータを同期するには、独自のインフラストラクチャにElasticコネクタサービスをデプロイする必要があります。このサービスは、ネイティブコネクタ用にElastic Cloud上で自動的に実行されます。
• connector_idパラメータは、既存のコネクタを参照する必要があります。
• 構成valuesを更新するには、コネクタconfigurationスキーマがElasticコネクタサービスの実行中のインスタンスによって最初に登録されている必要があります。
• 構成フィールドがサードパーティデータソースの構成スキーマと互換性があることを確認してください。詳細については、各コネクタのリファレンスを参照してください。

パスパラメータ

• <connector_id>
• (必須、文字列)

リクエストボディ

• values
• (オプション、オブジェクト) コネクタの構成値で、登録されたスキーマ内の構成フィールドとそれぞれの値のマッピングとして表されます。
• configuration
• (オプション、オブジェクト) コネクタの構成スキーマ定義。構成フィールドは、各キーが特定の構成フィールド名を表し、値がConnectorConfigurationオブジェクトであるマップです。コネクタ管理にはvaluesを使用して構成値を渡します。configurationオブジェクトは、Elasticコネクタサービスによってコネクタ構成スキーマを登録するために使用されます。

レスポンスコード

• 200
• コネクタ構成が正常に更新されました。
• 400
• connector_idが提供されていないか、リクエストペイロードが不正です。
• 404 (リソースが不足しています)
• connector_idに一致するコネクタが見つかりませんでした。

例

以下の例は、sharepoint_onlineコネクタを構成します。サポートされている構成オプションは、Sharepoint Onlineコネクタのドキュメントで確認するか、コネクタを取得を使用してコネクタのconfigurationフィールドのスキーマを調べることで見つけることができます。

Python

resp = client.connector.update_configuration(
   connector_id="my-spo-connector",
   values={
   "tenant_id": "my-tenant-id",
   "tenant_name": "my-sharepoint-site",
   "client_id": "foo",
   "secret_value": "bar",
   "site_collections": "*"
   },
)
print(resp)

Js

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
   tenant_id: "my-tenant-id",
   tenant_name: "my-sharepoint-site",
   client_id: "foo",
   secret_value: "bar",
   site_collections: "*",
  },
});
console.log(response);

コンソール

PUT _connector/my-spo-connector/_configuration
{
   "values": {
   "tenant_id": "my-tenant-id",
   "tenant_name": "my-sharepoint-site",
   "client_id": "foo",
   "secret_value": "bar",
   "site_collections": "*"
   }
}

コンソール-結果

{
   "result": "updated"
}

コネクタを最初に設定する際には、同期を開始するためにすべての必須構成詳細を提供する必要があります。しかし、このAPIを使用してフィールドのサブセットのみを更新することもできます。以下は、secret_valueフィールドのみをsharepoint_onlineコネクタに対して更新する例です。他の構成値は変更されません。

Python

resp = client.connector.update_configuration(
   connector_id="my-spo-connector",
   values={
   "secret_value": "foo-bar"
   },
)
print(resp)

Js

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
   secret_value: "foo-bar",
  },
});
console.log(response);

コンソール

PUT _connector/my-spo-connector/_configuration
{
   "values": {
   "secret_value": "foo-bar"
   }
}

コンソール-結果

{
   "result": "updated"
}