コネクタ機能の更新（Update connector features）

コネクタ機能APIの更新

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

コネクタのfeaturesを管理します。このエンドポイントは、コネクタの以下の側面を制御するために使用できます：

• ドキュメントレベルのセキュリティ
• 増分同期
• 高度な同期ルール
• 基本的な同期ルール

通常、実行中のコネクタサービスはこれらの機能を自動的に管理します。ただし、このAPIを使用してデフォルトの動作をオーバーライドすることができます。

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

リクエスト

PUT _connector/<connector_id>/_features

前提条件

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

パスパラメータ

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

リクエストボディ

• features
• (必須、オブジェクト) コネクタ機能を含むオブジェクト。
  • document_level_security (オプション、オブジェクト) enabledフラグでドキュメントレベルのセキュリティが有効かどうかを制御します。
  • incremental_sync (オプション、オブジェクト) enabledフラグで増分同期が有効かどうかを制御します。
  • native_connector_api_keys (オプション、オブジェクト) enabledフラグでネイティブコネクタAPIキーが有効かどうかを制御します。
  • sync_rules (オプション、オブジェクト) 同期ルールを制御します。
    • advanced (オプション、オブジェクト) enabledフラグで高度な同期ルールが有効かどうかを制御します。
    • basic (オプション、オブジェクト) enabledフラグで基本的な同期ルールが有効かどうかを制御します。

レスポンスコード

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

例

次の例は、ID my-connectorのコネクタのfeaturesフィールドを更新します：

Python

resp = client.perform_request(
   "PUT",
   "/_connector/my-connector/_features",
   headers={"Content-Type": "application/json"},
   body={
   "features": {
   "document_level_security": {
   "enabled": True
   },
   "incremental_sync": {
   "enabled": True
   },
   "sync_rules": {
   "advanced": {
   "enabled": False
   },
   "basic": {
   "enabled": True
   }
   }
   }
   },
)
print(resp)

Js

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/my-connector/_features",
  body: {
   features: {
   document_level_security: {
   enabled: true,
   },
   incremental_sync: {
   enabled: true,
   },
   sync_rules: {
   advanced: {
   enabled: false,
   },
   basic: {
   enabled: true,
   },
   },
   },
  },
});
console.log(response);

コンソール

PUT _connector/my-connector/_features
{
  "features": {
   "document_level_security": {
   "enabled": true
   },
   "incremental_sync": {
   "enabled": true
   },
   "sync_rules": {
   "advanced": {
   "enabled": false
   },
   "basic": {
   "enabled": true
   }
   }
  }
}

コンソール-結果

{
   "result": "updated"
}

このエンドポイントは、featuresフィールドの部分的な更新をサポートしています。たとえば、document_level_security機能のみを更新するには、次のリクエストを送信できます：

Python

resp = client.perform_request(
   "PUT",
   "/_connector/my-connector/_features",
   headers={"Content-Type": "application/json"},
   body={
   "features": {
   "document_level_security": {
   "enabled": True
   }
   }
   },
)
print(resp)

Js

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/my-connector/_features",
  body: {
   features: {
   document_level_security: {
   enabled: true,
   },
   },
  },
});
console.log(response);

コンソール

PUT _connector/my-connector/_features
{
  "features": {
   "document_level_security": {
   "enabled": true
   }
  }
}

コンソール-結果

{
   "result": "updated"
}