コネクタの最終同期統計APIの更新

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

コネクタの最終同期に関連するフィールドを更新します。

このアクションは分析と監視に使用されます。

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

リクエスト

PUT _connector/<connector_id>/_last_sync

前提条件

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

パスパラメータ

  • <connector_id>
  • （必須、文字列）

リクエストボディ

  • last_access_control_sync_error
  • （オプション、文字列）アクセス制御の同期に関連する最後のエラーメッセージ（ある場合）。
  • last_access_control_sync_scheduled_at
  • （オプション、日時）最後のアクセス制御の同期がスケジュールされた日時。
  • last_access_control_sync_status
  • （オプション、ConnectorSyncStatus）最後のアクセス制御の同期のステータス。
  • last_deleted_document_count
  • （オプション、長整数）最後の同期プロセスで削除されたドキュメントの数。
  • last_incremental_sync_scheduled_at
  • （オプション、日時）最後の増分同期がスケジュールされた日時。
  • last_indexed_document_count
  • （オプション、長整数）最後の同期でインデックスされたドキュメントの数。
  • last_sync_error
  • （オプション、文字列）同期プロセス中に遭遇した最後のエラーメッセージ（ある場合）。
  • last_sync_scheduled_at
  • （オプション、日時）最後の同期がスケジュールされた日時。
  • last_sync_status
  • （オプション、ConnectorSyncStatus）最後の同期のステータス。
  • last_synced
  • （オプション、日時）最後の成功した同期の日時。
  2. -  `````canceling`````：同期プロセスがキャンセルされる過程にあります。  
  3. -  `````canceled`````：同期プロセスがキャンセルされました。  
  4. -  `````completed`````：同期プロセスが正常に完了しました。  
  5. -  `````error`````：同期プロセス中にエラーが発生しました。  
  6. -  `````in_progress`````：同期プロセスが現在進行中です。  
  7. -  `````pending`````：同期が保留中で、まだ開始されていません。  
  8. -  `````suspended`````：同期プロセスが一時的に中断されました。
  11. ## レスポンスコード
  13. -   `````200
  • コネクタの最終同期統計が正常に更新されました。
  • 400
  • connector_idが提供されていないか、リクエストペイロードが不正です。
  • 404（リソースが不足しています）
  • connector_idに一致するコネクタが見つかりませんでした。

例

以下の例は、IDがmy-connectorのコネクタの最終同期統計を更新します:

Python

  1. resp = client.connector.last_sync(
  2.    connector_id="my-connector",
  3.    last_access_control_sync_error="Houston, we have a problem!",
  4.    last_access_control_sync_scheduled_at="2023-11-09T15:13:08.231Z",
  5.    last_access_control_sync_status="pending",
  6.    last_deleted_document_count=42,
  7.    last_incremental_sync_scheduled_at="2023-11-09T15:13:08.231Z",
  8.    last_indexed_document_count=42,
  9.    last_sync_error="Houston, we have a problem!",
  10.    last_sync_scheduled_at="2024-11-09T15:13:08.231Z",
  11.    last_sync_status="completed",
  12.    last_synced="2024-11-09T15:13:08.231Z",
  13. )
  14. print(resp)

Ruby

  1. response = client.connector.last_sync(
  2.   connector_id: 'my-connector',
  3.   body: {
  4.    last_access_control_sync_error: 'Houston, we have a problem!',
  5.    last_access_control_sync_scheduled_at: '2023-11-09T15:13:08.231Z',
  6.    last_access_control_sync_status: 'pending',
  7.    last_deleted_document_count: 42,
  8.    last_incremental_sync_scheduled_at: '2023-11-09T15:13:08.231Z',
  9.    last_indexed_document_count: 42,
  10.    last_sync_error: 'Houston, we have a problem!',
  11.    last_sync_scheduled_at: '2024-11-09T15:13:08.231Z',
  12.    last_sync_status: 'completed',
  13.    last_synced: '2024-11-09T15:13:08.231Z'
  14.   }
  15. )
  16. puts response

Js

  1. const response = await client.connector.lastSync({
  2.   connector_id: "my-connector",
  3.   last_access_control_sync_error: "Houston, we have a problem!",
  4.   last_access_control_sync_scheduled_at: "2023-11-09T15:13:08.231Z",
  5.   last_access_control_sync_status: "pending",
  6.   last_deleted_document_count: 42,
  7.   last_incremental_sync_scheduled_at: "2023-11-09T15:13:08.231Z",
  8.   last_indexed_document_count: 42,
  9.   last_sync_error: "Houston, we have a problem!",
  10.   last_sync_scheduled_at: "2024-11-09T15:13:08.231Z",
  11.   last_sync_status: "completed",
  12.   last_synced: "2024-11-09T15:13:08.231Z",
  13. });
  14. console.log(response);

コンソール

  1. PUT _connector/my-connector/_last_sync
  2. {
  3.    "last_access_control_sync_error": "Houston, we have a problem!",
  4.    "last_access_control_sync_scheduled_at": "2023-11-09T15:13:08.231Z",
  5.    "last_access_control_sync_status": "pending",
  6.    "last_deleted_document_count": 42,
  7.    "last_incremental_sync_scheduled_at": "2023-11-09T15:13:08.231Z",
  8.    "last_indexed_document_count": 42,
  9.    "last_sync_error": "Houston, we have a problem!",
  10.    "last_sync_scheduled_at": "2024-11-09T15:13:08.231Z",
  11.    "last_sync_status": "completed",
  12.    "last_synced": "2024-11-09T15:13:08.231Z"
  13. }

コンソール-結果

  1. {
  2.    "result": "updated"
  3. }